Class default

Index

Constructors

Methods

add batchList callSPPXML createUser delete getAuthUrl list read refreshUserToken setAccessToken update whoami configureLogging disableLogging enableLogging setLogLevel

Constructors

constructor

new default(options: SPPClientOptions): default
Parameters
- options: SPPClientOptions
Returns default
- Defined in src/SPPClient.ts:56

Methods

add

add<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    payload: Partial<BORecordMap[BO]> | Partial<BORecordMap[BO]>[],
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- payload: Partial<BORecordMap[BO]> | Partial<BORecordMap[BO]>[]
Returns Promise<BORecordMap[BO][]>
- Defined in src/SPPClient.ts:321

batchList

batchList<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    filter?: Record<string, any>[],
    limit?: number,
    offset?: number,
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- filter: Record<string, any>[] = []
- limit: number = 1000
- offset: number = 0
Returns Promise<BORecordMap[BO][]>
- Defined in src/SPPClient.ts:305

callSPPXML

callSPPXML<T = any>(rawXml: string, retry?: boolean): Promise<T[]>
Type Parameters
- T = any
Parameters
- rawXml: string
- retry: boolean = true
Returns Promise<T[]>
- Defined in src/SPPClient.ts:216

createUser

createUser(
    user: Partial<User>,
    company: Partial<Company>,
    options?: CreateUserOptions,
): Promise<User>
CreateUser command - Adds or Updates a User object Note: OpenAir requires BOTH User and Company objects for CreateUser
Parameters
- user: Partial<User>
- company: Partial<Company>
- Optionaloptions: CreateUserOptions
Returns Promise<User>
- Defined in src/SPPClient.ts:347

delete

delete<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    id: string | string[],
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- id: string | string[]
Returns Promise<BORecordMap[BO][]>
- Defined in src/SPPClient.ts:336

getAuthUrl

getAuthUrl(): string
Returns string
- Defined in src/SPPClient.ts:141

list

list<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    filter?: Record<string, any>,
    limit?: number,
    offset?: number,
): Promise<BORecordMap[BO][]>
List records for any Business Object (BO) by name.
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- filter: Record<string, any> = {}
- limit: number = 1000
- offset: number = 0
Returns Promise<BORecordMap[BO][]>
- Defined in src/SPPClient.ts:296

read

read<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    id: string,
): Promise<undefined | BORecordMap[BO]>
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- id: string
Returns Promise<undefined | BORecordMap[BO]>
- Defined in src/SPPClient.ts:314

refreshUserToken

refreshUserToken(refreshToken: string): Promise<RefreshTokenResponse>
Parameters
- refreshToken: string
Returns Promise<RefreshTokenResponse>
- Defined in src/SPPClient.ts:161

setAccessToken

setAccessToken(token: undefined | null | string): void
Parameters
- token: undefined | null | string
Returns void
- Defined in src/SPPClient.ts:157

update

update<
    BO extends
        | "Customerpo"
        | "Invoice"
        | "Project"
        | "Slip"
        | "Timesheet"
        | "ApprovalLine"
        | "LeaveAccrualRule"
        | "Projectlocation"
        | "Customer"
        | "History"
        | "Costtype"
        | "ItemToUserLocation"
        | "Payrolltype"
        | "Product"
        | "Report"
        | "InvoiceLayout"
        | "AttributeDescription"
        | "Attachment"
        | "Currency"
        | "HierarchyNode"
        | "Preference"
        | "Jobcode"
        | "ForexInput"
        | "Filterset"
        | "Workspace"
        | "Workspaceuser"
        | "User"
        | "AccountingPeriod"
        | "Agreement_to_project"
        | "ActualCost"
        | "Agreement"
        | "ApprovalProcess"
        | "Attribute"
        | "AttributeSet"
        | "BillingSplit"
        | "Booking"
        | "BookingByDay"
        | "BookingRequest"
        | "BookingType"
        | "Budget"
        | "BudgetAllocation"
        | "Category"
        | "CategoryN"
        | "Ccrate"
        | "Company"
        | "Contact"
        | "CostCategory"
        | "CostCenter"
        | "CustomerLocation"
        | "CurrencyRate"
        | "Deal"
        | "DealContact"
        | "DealSchedule"
        | "DealToProject"
        | "Department"
        | "EntityTag"
        | "Envelope"
        | "Estimate"
        | "EstimateAdjustment"
        | "EstimateExpense"
        | "EstimateLabor"
        | "EstimateMarkup"
        | "EstimatePhase"
        | "Event"
        | "ExpensePolicy"
        | "ExpensePolicyItem"
        | "Filter"
        | "Fulfillment"
        | "Hierarchy"
        | "HistoryNotes"
        | "ImportExport"
        | "Issue"
        | "IssueCategory"
        | "IssueSeverity"
        | "IssueSource"
        | "IssueStage"
        | "IssueStatus"
        | "Item"
        | "JobCodeUsed"
        | "LeaveAccrualRuleToUser"
        | "LeaveAccrualTransaction"
        | "LoadedCost"
        | "Module"
        | "NewsFeed"
        | "NewsFeedMessage"
        | "Payment"
        | "PaymentTerms"
        | "PaymentType"
        | "PendingBooking"
        | "ProjectAssign"
        | "ProjectAssignmentProfile"
        | "ProjectBillingTransaction"
        | "ProjectBudgetGroup"
        | "ProjectBudgetRules"
        | "ProjectBudgetTransaction"
        | "ProjectGroup"
        | "ProjectPricing"
        | "ProjectStage"
        | "ProjectTask"
        | "ProjectTaskAssign"
        | "ProjectTaskEstimate"
        | "ProjectTask_Type"
        | "Proposal"
        | "ProposalBlock"
        | "Proxy"
        | "PurchaseItem"
        | "PurchaseOrder"
        | "PurchaseRequest"
        | "Purchaser"
        | "RateCardItem"
        | "Ratecard"
        | "Reimbursement"
        | "Repeat"
        | "Request_item"
        | "ResourceAttachment"
        | "ResourceProfile"
        | "ResourceProfileType"
        | "ResourceRequest"
        | "ResourceRequestQueue"
        | "ResourceSearch"
        | "RevenueContainer"
        | "RevenueProjection"
        | "RevenueRecognitionRule"
        | "RevenueRecognitionRuleAmount"
        | "RevenueRecognitionTransaction"
        | "RevenueStage"
        | "Role"
        | "ScheduleByDay"
        | "Scheduleexception"
        | "Schedulerequest"
        | "Schedulerequest_item"
        | "SlipProjection"
        | "SlipStage"
        | "SummaryView"
        | "TagGroup"
        | "TagGroupAttribute"
        | "TargetUtilization"
        | "Task"
        | "TaskTimecard"
        | "TaskAdjustment"
        | "TaxLocation"
        | "TaxRate"
        | "Term"
        | "Ticket"
        | "TimeType"
        | "Timecard"
        | "Todo"
        | "Uprate"
        | "UserWorkSchedule"
        | "Vendor"
        | "ViewFilter"
        | "ViewFilterRule"
        | "UserLocation"
        | "WorkScheduleWorkHour"
        | "WorkspaceLink",
>(
    bo: BO,
    idOrUpdates: string | { changes: Partial<BORecordMap[BO]>; id: string }[],
    changes?: Partial<BORecordMap[BO]>,
): Promise<BORecordMap[BO] | BORecordMap[BO][]>
Type Parameters
- BO extends
      | "Customerpo"
      | "Invoice"
      | "Project"
      | "Slip"
      | "Timesheet"
      | "ApprovalLine"
      | "LeaveAccrualRule"
      | "Projectlocation"
      | "Customer"
      | "History"
      | "Costtype"
      | "ItemToUserLocation"
      | "Payrolltype"
      | "Product"
      | "Report"
      | "InvoiceLayout"
      | "AttributeDescription"
      | "Attachment"
      | "Currency"
      | "HierarchyNode"
      | "Preference"
      | "Jobcode"
      | "ForexInput"
      | "Filterset"
      | "Workspace"
      | "Workspaceuser"
      | "User"
      | "AccountingPeriod"
      | "Agreement_to_project"
      | "ActualCost"
      | "Agreement"
      | "ApprovalProcess"
      | "Attribute"
      | "AttributeSet"
      | "BillingSplit"
      | "Booking"
      | "BookingByDay"
      | "BookingRequest"
      | "BookingType"
      | "Budget"
      | "BudgetAllocation"
      | "Category"
      | "CategoryN"
      | "Ccrate"
      | "Company"
      | "Contact"
      | "CostCategory"
      | "CostCenter"
      | "CustomerLocation"
      | "CurrencyRate"
      | "Deal"
      | "DealContact"
      | "DealSchedule"
      | "DealToProject"
      | "Department"
      | "EntityTag"
      | "Envelope"
      | "Estimate"
      | "EstimateAdjustment"
      | "EstimateExpense"
      | "EstimateLabor"
      | "EstimateMarkup"
      | "EstimatePhase"
      | "Event"
      | "ExpensePolicy"
      | "ExpensePolicyItem"
      | "Filter"
      | "Fulfillment"
      | "Hierarchy"
      | "HistoryNotes"
      | "ImportExport"
      | "Issue"
      | "IssueCategory"
      | "IssueSeverity"
      | "IssueSource"
      | "IssueStage"
      | "IssueStatus"
      | "Item"
      | "JobCodeUsed"
      | "LeaveAccrualRuleToUser"
      | "LeaveAccrualTransaction"
      | "LoadedCost"
      | "Module"
      | "NewsFeed"
      | "NewsFeedMessage"
      | "Payment"
      | "PaymentTerms"
      | "PaymentType"
      | "PendingBooking"
      | "ProjectAssign"
      | "ProjectAssignmentProfile"
      | "ProjectBillingTransaction"
      | "ProjectBudgetGroup"
      | "ProjectBudgetRules"
      | "ProjectBudgetTransaction"
      | "ProjectGroup"
      | "ProjectPricing"
      | "ProjectStage"
      | "ProjectTask"
      | "ProjectTaskAssign"
      | "ProjectTaskEstimate"
      | "ProjectTask_Type"
      | "Proposal"
      | "ProposalBlock"
      | "Proxy"
      | "PurchaseItem"
      | "PurchaseOrder"
      | "PurchaseRequest"
      | "Purchaser"
      | "RateCardItem"
      | "Ratecard"
      | "Reimbursement"
      | "Repeat"
      | "Request_item"
      | "ResourceAttachment"
      | "ResourceProfile"
      | "ResourceProfileType"
      | "ResourceRequest"
      | "ResourceRequestQueue"
      | "ResourceSearch"
      | "RevenueContainer"
      | "RevenueProjection"
      | "RevenueRecognitionRule"
      | "RevenueRecognitionRuleAmount"
      | "RevenueRecognitionTransaction"
      | "RevenueStage"
      | "Role"
      | "ScheduleByDay"
      | "Scheduleexception"
      | "Schedulerequest"
      | "Schedulerequest_item"
      | "SlipProjection"
      | "SlipStage"
      | "SummaryView"
      | "TagGroup"
      | "TagGroupAttribute"
      | "TargetUtilization"
      | "Task"
      | "TaskTimecard"
      | "TaskAdjustment"
      | "TaxLocation"
      | "TaxRate"
      | "Term"
      | "Ticket"
      | "TimeType"
      | "Timecard"
      | "Todo"
      | "Uprate"
      | "UserWorkSchedule"
      | "Vendor"
      | "ViewFilter"
      | "ViewFilterRule"
      | "UserLocation"
      | "WorkScheduleWorkHour"
      | "WorkspaceLink"
Parameters
- bo: BO
- idOrUpdates: string | { changes: Partial<BORecordMap[BO]>; id: string }[]
- Optionalchanges: Partial<BORecordMap[BO]>
Returns Promise<BORecordMap[BO] | BORecordMap[BO][]>
- Defined in src/SPPClient.ts:328

whoami

whoami(): Promise<User>
Returns Promise<User>
- Defined in src/SPPClient.ts:355

`Static`configureLogging

configureLogging(
    config: {
        enabled?: boolean;
        level?: "debug" | "info" | "log" | "warn" | "error" | "none";
    },
): void
Configure logger settings
Parameters
- config: {
  enabled?: boolean;
  level?: "debug" | "info" | "log" | "warn" | "error" | "none";
  }
  Logger configuration options
Returns void
- Defined in src/SPPClient.ts:388

`Static`disableLogging

disableLogging(): void
Disable logging for all SPPClient instances

Returns void
- Defined in src/SPPClient.ts:372

`Static`enableLogging

enableLogging(): void
Enable logging for all SPPClient instances

Returns void
- Defined in src/SPPClient.ts:365

`Static`setLogLevel

setLogLevel(level: "debug" | "info" | "log" | "warn" | "error" | "none"): void
Set the log level for all SPPClient instances
Parameters
- level: "debug" | "info" | "log" | "warn" | "error" | "none"
  Minimum level to log (debug, info, log, warn, error, none)
Returns void
- Defined in src/SPPClient.ts:380

Class default

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

add

Type Parameters

Parameters

Returns Promise<BORecordMap[BO][]>

batchList

Type Parameters

Parameters

Returns Promise<BORecordMap[BO][]>

callSPPXML

Type Parameters

Parameters

Returns Promise<T[]>

createUser

Parameters

Returns Promise<User>

delete

Type Parameters

Parameters

Returns Promise<BORecordMap[BO][]>

getAuthUrl

Returns string

list

Type Parameters

Parameters

Returns Promise<BORecordMap[BO][]>

read

Type Parameters

Parameters

Returns Promise<undefined | BORecordMap[BO]>

refreshUserToken

Parameters

Returns Promise<RefreshTokenResponse>

setAccessToken

Parameters

Returns void

update

Type Parameters

Parameters

Returns Promise<BORecordMap[BO] | BORecordMap[BO][]>

whoami

Returns Promise<User>

StaticconfigureLogging

Parameters

Returns void

StaticdisableLogging

Returns void

StaticenableLogging

Returns void

StaticsetLogLevel

Parameters

Returns void

Settings

On This Page

`Static`configureLogging

`Static`disableLogging

`Static`enableLogging

`Static`setLogLevel