components: requestBodies: AccountingAccount: content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' required: true AccountingBill: content: application/json: schema: $ref: '#/components/schemas/AccountingBill' required: true AccountingCategory: content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' required: true AccountingContact: content: application/json: schema: $ref: '#/components/schemas/AccountingContact' required: true AccountingCreditmemo: content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' required: true AccountingExpense: content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' required: true AccountingInvoice: content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' required: true AccountingJournal: content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' required: true AccountingOrder: content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' required: true AccountingPurchaseorder: content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' required: true AccountingSalesorder: content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' required: true AccountingTaxrate: content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' required: true AccountingTransaction: content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' required: true AdsAd: content: application/json: schema: $ref: '#/components/schemas/AdsAd' required: true AdsCampaign: content: application/json: schema: $ref: '#/components/schemas/AdsCampaign' required: true AdsCreative: content: application/json: schema: $ref: '#/components/schemas/AdsCreative' required: true AdsGroup: content: application/json: schema: $ref: '#/components/schemas/AdsGroup' required: true AdsInsertionorder: content: application/json: schema: $ref: '#/components/schemas/AdsInsertionorder' required: true AdsOrganization: content: application/json: schema: $ref: '#/components/schemas/AdsOrganization' required: true AssessmentOrder: content: application/json: schema: $ref: '#/components/schemas/AssessmentOrder' required: true AssessmentPackage: content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' required: true AtsActivity: content: application/json: schema: $ref: '#/components/schemas/AtsActivity' required: true AtsApplication: content: application/json: schema: $ref: '#/components/schemas/AtsApplication' required: true AtsCandidate: content: application/json: schema: $ref: '#/components/schemas/AtsCandidate' required: true AtsCompany: content: application/json: schema: $ref: '#/components/schemas/AtsCompany' required: true AtsDocument: content: application/json: schema: $ref: '#/components/schemas/AtsDocument' required: true AtsInterview: content: application/json: schema: $ref: '#/components/schemas/AtsInterview' required: true AtsJob: content: application/json: schema: $ref: '#/components/schemas/AtsJob' required: true AtsScorecard: content: application/json: schema: $ref: '#/components/schemas/AtsScorecard' required: true CalendarCalendar: content: application/json: schema: $ref: '#/components/schemas/CalendarCalendar' required: true CalendarEvent: content: application/json: schema: $ref: '#/components/schemas/CalendarEvent' required: true CalendarLink: content: application/json: schema: $ref: '#/components/schemas/CalendarLink' required: true CalendarWebinar: content: application/json: schema: $ref: '#/components/schemas/CalendarWebinar' required: true CommerceCollection: content: application/json: schema: $ref: '#/components/schemas/CommerceCollection' required: true CommerceInventory: content: application/json: schema: $ref: '#/components/schemas/CommerceInventory' required: true CommerceItem: content: application/json: schema: $ref: '#/components/schemas/CommerceItem' required: true CommerceItemvariant: content: application/json: schema: $ref: '#/components/schemas/CommerceItemvariant' required: true CommerceLocation: content: application/json: schema: $ref: '#/components/schemas/CommerceLocation' required: true CommerceReservation: content: application/json: schema: $ref: '#/components/schemas/CommerceReservation' required: true CommerceReview: content: application/json: schema: $ref: '#/components/schemas/CommerceReview' required: true CommerceSaleschannel: content: application/json: schema: $ref: '#/components/schemas/CommerceSaleschannel' required: true Connection: content: application/json: schema: $ref: '#/components/schemas/Connection' required: true CrmCompany: content: application/json: schema: $ref: '#/components/schemas/CrmCompany' required: true CrmContact: content: application/json: schema: $ref: '#/components/schemas/CrmContact' required: true CrmDeal: content: application/json: schema: $ref: '#/components/schemas/CrmDeal' required: true CrmEvent: content: application/json: schema: $ref: '#/components/schemas/CrmEvent' required: true CrmLead: content: application/json: schema: $ref: '#/components/schemas/CrmLead' required: true CrmPipeline: content: application/json: schema: $ref: '#/components/schemas/CrmPipeline' required: true Environments: content: application/json: schema: $ref: '#/components/schemas/Environments' required: true FormsForm: content: application/json: schema: $ref: '#/components/schemas/FormsForm' required: true GenaiEmbedding: content: application/json: schema: $ref: '#/components/schemas/GenaiEmbedding' required: true GenaiPrompt: content: application/json: schema: $ref: '#/components/schemas/GenaiPrompt' required: true HrisBankaccount: content: application/json: schema: $ref: '#/components/schemas/HrisBankaccount' required: true HrisBenefit: content: application/json: schema: $ref: '#/components/schemas/HrisBenefit' required: true HrisCompany: content: application/json: schema: $ref: '#/components/schemas/HrisCompany' required: true HrisDeduction: content: application/json: schema: $ref: '#/components/schemas/HrisDeduction' required: true HrisDevice: content: application/json: schema: $ref: '#/components/schemas/HrisDevice' required: true HrisEmployee: content: application/json: schema: $ref: '#/components/schemas/HrisEmployee' required: true HrisGroup: content: application/json: schema: $ref: '#/components/schemas/HrisGroup' required: true HrisLocation: content: application/json: schema: $ref: '#/components/schemas/HrisLocation' required: true HrisTimeoff: content: application/json: schema: $ref: '#/components/schemas/HrisTimeoff' required: true HrisTimeshift: content: application/json: schema: $ref: '#/components/schemas/HrisTimeshift' required: true KmsComment: content: application/json: schema: $ref: '#/components/schemas/KmsComment' required: true KmsPage: content: application/json: schema: $ref: '#/components/schemas/KmsPage' required: true KmsSpace: content: application/json: schema: $ref: '#/components/schemas/KmsSpace' required: true LmsActivity: content: application/json: schema: $ref: '#/components/schemas/LmsActivity' required: true LmsClass: content: application/json: schema: $ref: '#/components/schemas/LmsClass' required: true LmsCollection: content: application/json: schema: $ref: '#/components/schemas/LmsCollection' required: true LmsContent: content: application/json: schema: $ref: '#/components/schemas/LmsContent' required: true LmsCourse: content: application/json: schema: $ref: '#/components/schemas/LmsCourse' required: true LmsInstructor: content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' required: true LmsStudent: content: application/json: schema: $ref: '#/components/schemas/LmsStudent' required: true MarketingCampaign: content: application/json: schema: $ref: '#/components/schemas/MarketingCampaign' required: true MarketingList: content: application/json: schema: $ref: '#/components/schemas/MarketingList' required: true MarketingMember: content: application/json: schema: $ref: '#/components/schemas/MarketingMember' required: true MessagingEvent: content: application/json: schema: $ref: '#/components/schemas/MessagingEvent' required: true MessagingMessage: content: application/json: schema: $ref: '#/components/schemas/MessagingMessage' required: true MetadataMetadata: content: application/json: schema: $ref: '#/components/schemas/MetadataMetadata' required: true PaymentLink: content: application/json: schema: $ref: '#/components/schemas/PaymentLink' required: true PaymentPayment: content: application/json: schema: $ref: '#/components/schemas/PaymentPayment' required: true PaymentSubscription: content: application/json: schema: $ref: '#/components/schemas/PaymentSubscription' required: true RepoBranch: content: application/json: schema: $ref: '#/components/schemas/RepoBranch' required: true RepoCommit: content: application/json: schema: $ref: '#/components/schemas/RepoCommit' required: true RepoOrganization: content: application/json: schema: $ref: '#/components/schemas/RepoOrganization' required: true RepoPullrequest: content: application/json: schema: $ref: '#/components/schemas/RepoPullrequest' required: true RepoRepository: content: application/json: schema: $ref: '#/components/schemas/RepoRepository' required: true ScimGroup: content: application/json: schema: $ref: '#/components/schemas/ScimGroup' required: true ScimUser: content: application/json: schema: $ref: '#/components/schemas/ScimUser' required: true ShippingLabel: content: application/json: schema: $ref: '#/components/schemas/ShippingLabel' required: true ShippingRate: content: application/json: schema: $ref: '#/components/schemas/ShippingRate' required: true ShippingShipment: content: application/json: schema: $ref: '#/components/schemas/ShippingShipment' required: true SigningDocument: content: application/json: schema: $ref: '#/components/schemas/SigningDocument' required: true SigningSignatory: content: application/json: schema: $ref: '#/components/schemas/SigningSignatory' required: true StorageFile: content: application/json: schema: $ref: '#/components/schemas/StorageFile' required: true TaskComment: content: application/json: schema: $ref: '#/components/schemas/TaskComment' required: true TaskProject: content: application/json: schema: $ref: '#/components/schemas/TaskProject' required: true TaskTask: content: application/json: schema: $ref: '#/components/schemas/TaskTask' required: true TicketingCategory: content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' required: true TicketingCustomer: content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' required: true TicketingNote: content: application/json: schema: $ref: '#/components/schemas/TicketingNote' required: true TicketingTicket: content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' required: true UcComment: content: application/json: schema: $ref: '#/components/schemas/UcComment' required: true UcContact: content: application/json: schema: $ref: '#/components/schemas/UcContact' required: true UcRecording: content: application/json: schema: $ref: '#/components/schemas/UcRecording' required: true VerificationRequest: content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' required: true Webhook: content: application/json: schema: $ref: '#/components/schemas/Webhook' required: true schemas: AccountingAccount: description: Chart of accounts properties: balance: type: number created_at: format: date-time type: string currency: type: string customer_defined_code: type: string description: type: string group: type: string id: type: string is_payable: type: boolean name: type: string organization_id: type: string parent_id: type: string raw: additionalProperties: true type: object section: type: string status: enum: - ACTIVE - ARCHIVED type: string x-speakeasy-unknown-values: allow subgroup: type: string subsection: type: string taxonomy: $ref: '#/components/schemas/property_AccountingAccount_taxonomy' type: enum: - ACCOUNTS_PAYABLE - ACCOUNTS_RECEIVABLE - BANK - CREDIT_CARD - FIXED_ASSET - LIABILITY - EQUITY - EXPENSE - REVENUE - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AccountingAccountTaxonomy: properties: original_type: type: string type: enum: - CLASSIFICATION - GROUP - SUBGROUP - SYSTEM_ROLE - OTHER type: string x-speakeasy-unknown-values: allow value: type: string required: - type - value type: object AccountingAccounts: items: $ref: '#/components/schemas/AccountingAccount' type: array AccountingAssociatedContact: properties: emails: $ref: '#/components/schemas/property_AccountingAssociatedContact_emails' id: type: string name: type: string type: object AccountingAttachment: properties: download_url: type: string id: type: string mime_type: type: string name: type: string type: object AccountingBalancesheet: properties: assets: $ref: '#/components/schemas/property_AccountingBalancesheet_assets' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string equity: $ref: '#/components/schemas/property_AccountingBalancesheet_equity' id: type: string liabilities: $ref: '#/components/schemas/property_AccountingBalancesheet_liabilities' name: type: string net_assets_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingBalancesheetItem: properties: account_id: type: string amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingBalancesheetItem_sub_items' type: object AccountingBalancesheets: items: $ref: '#/components/schemas/AccountingBalancesheet' type: array AccountingBill: properties: attachments: $ref: '#/components/schemas/property_AccountingBill_attachments' balance_amount: type: number bill_number: type: string cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingBill_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string url: type: string type: object AccountingBills: items: $ref: '#/components/schemas/AccountingBill' type: array AccountingCashflow: description: Sections properties: cash_beginning_amount: type: number cash_ending_amount: type: number category_ids: $ref: '#/components/schemas/property_AccountingCashflow_category_ids' contact_id: type: string created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string financing_sections: $ref: '#/components/schemas/property_AccountingCashflow_financing_sections' id: type: string investing_sections: $ref: '#/components/schemas/property_AccountingCashflow_investing_sections' name: type: string net_change_in_cash_amount: type: number operating_sections: $ref: '#/components/schemas/property_AccountingCashflow_operating_sections' raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingCashflowItem: properties: account_id: type: string amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingCashflowItem_sub_items' transaction_ids: $ref: '#/components/schemas/property_AccountingCashflowItem_transaction_ids' type: object AccountingCashflowSection: properties: items: $ref: '#/components/schemas/property_AccountingCashflowSection_items' section_name: type: string total_amount: type: number type: object AccountingCashflows: items: $ref: '#/components/schemas/AccountingCashflow' type: array AccountingCategories: items: $ref: '#/components/schemas/AccountingCategory' type: array AccountingCategory: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object AccountingContact: properties: associated_contacts: $ref: '#/components/schemas/property_AccountingContact_associated_contacts' billing_address: $ref: '#/components/schemas/property_AccountingContact_billing_address' company_name: type: string created_at: format: date-time type: string currency: default: USD type: string emails: $ref: '#/components/schemas/property_AccountingContact_emails' first_name: type: string id: type: string identification: type: string is_active: type: boolean is_customer: type: boolean is_supplier: type: boolean last_name: type: string name: type: string organization_id: type: string payment_methods: $ref: '#/components/schemas/property_AccountingContact_payment_methods' portal_url: type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingContact_shipping_address' tax_exemption: enum: - FEDERAL_GOV - REGION_GOV - LOCAL_GOV - TRIBAL_GOV - CHARITABLE_ORG - RELIGIOUS_ORG - EDUCATIONAL_ORG - MEDICAL_ORG - RESALE - FOREIGN - OTHER type: string x-speakeasy-unknown-values: allow tax_number: type: string telephones: $ref: '#/components/schemas/property_AccountingContact_telephones' updated_at: format: date-time type: string type: object AccountingContactPaymentMethod: properties: default: type: boolean id: type: string name: type: string type: enum: - ACH - ALIPAY - CARD - GIROPAY - IDEAL - OTHER - PAYPAL - WIRE - CHECK type: string x-speakeasy-unknown-values: allow required: - type type: object AccountingContacts: items: $ref: '#/components/schemas/AccountingContact' type: array AccountingCreditmemo: properties: attachments: $ref: '#/components/schemas/property_AccountingCreditmemo_attachments' balance_amount: type: number cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string creditmemo_number: type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingCreditmemo_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string url: type: string type: object AccountingCreditmemoes: items: $ref: '#/components/schemas/AccountingCreditmemo' type: array AccountingEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow type: object AccountingExpense: properties: account_id: type: string approved_at: format: date-time type: string approver_user_id: type: string contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingExpense_lineitems' name: type: string organization_id: type: string payment_method: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object reimbursed_amount: type: number reimbursed_at: format: date-time type: string tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string user_id: type: string type: object AccountingExpenses: items: $ref: '#/components/schemas/AccountingExpense' type: array AccountingInvoice: properties: attachments: $ref: '#/components/schemas/property_AccountingInvoice_attachments' balance_amount: type: number cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string invoice_number: type: string lineitems: $ref: '#/components/schemas/property_AccountingInvoice_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object reference: type: string refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number type: enum: - BILL - INVOICE - CREDITMEMO type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string url: type: string type: object AccountingInvoices: items: $ref: '#/components/schemas/AccountingInvoice' type: array AccountingJournal: properties: created_at: format: date-time type: string currency: type: string description: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingJournal_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object reference: type: string source: type: string tax_amount: type: number taxrate_id: type: string updated_at: format: date-time type: string type: object AccountingJournalLineitem: properties: account_id: type: string category_ids: $ref: '#/components/schemas/property_AccountingJournalLineitem_category_ids' contact_id: type: string credit_amount: type: number debit_amount: type: number description: type: string group_id: type: string id: type: string invoice_id: type: string organization_id: type: string payment_id: type: string project_id: type: string tax_amount: type: number total_amount: type: number type: object AccountingJournals: items: $ref: '#/components/schemas/AccountingJournal' type: array AccountingLineitem: properties: account_id: type: string category_ids: $ref: '#/components/schemas/property_AccountingLineitem_category_ids' created_at: format: date-time type: string discount_amount: type: number id: type: string item_description: type: string item_id: type: string item_name: type: string item_sku: type: string item_variants: $ref: '#/components/schemas/property_AccountingLineitem_item_variants' locations: $ref: '#/components/schemas/property_AccountingLineitem_locations' notes: type: string refund_amount: type: number refunded_at: format: date-time type: string tax_amount: type: number taxrate_id: type: string total_amount: type: number unit_amount: type: number unit_quantity: type: number updated_at: format: date-time type: string type: object AccountingOrder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingOrder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingOrder_lineitems' posted_at: format: date-time type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingOrder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number type: enum: - SALES - PURCHASE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AccountingOrders: items: $ref: '#/components/schemas/AccountingOrder' type: array AccountingOrganization: properties: address: $ref: '#/components/schemas/property_AccountingOrganization_address' created_at: format: date-time type: string currency: type: string fiscal_year_end_month: type: number id: type: string legal_name: type: string name: type: string organization_code: type: string parent_id: type: string raw: additionalProperties: true type: object tax_number: type: string timezone: type: string updated_at: format: date-time type: string website: type: string type: object AccountingOrganizations: items: $ref: '#/components/schemas/AccountingOrganization' type: array AccountingProfitloss: properties: category_ids: $ref: '#/components/schemas/property_AccountingProfitloss_category_ids' cost_of_goods_sold: $ref: '#/components/schemas/property_AccountingProfitloss_cost_of_goods_sold' cost_of_goods_sold_sections: $ref: '#/components/schemas/property_AccountingProfitloss_cost_of_goods_sold_sections' cost_of_goods_sold_total_amount: type: number created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string expenses: $ref: '#/components/schemas/property_AccountingProfitloss_expenses' expenses_sections: $ref: '#/components/schemas/property_AccountingProfitloss_expenses_sections' expenses_total_amount: type: number gross_profit_amount: type: number id: type: string income: $ref: '#/components/schemas/property_AccountingProfitloss_income' income_sections: $ref: '#/components/schemas/property_AccountingProfitloss_income_sections' income_total_amount: type: number name: type: string net_income_amount: type: number net_profit_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingProfitlossAccount: properties: account_id: type: string account_name: type: string total_amount: type: number transaction_ids: $ref: '#/components/schemas/property_AccountingProfitlossAccount_transaction_ids' type: object AccountingProfitlossCategory: description: '@deprecated' properties: amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingProfitlossCategory_sub_items' type: object AccountingProfitlossSection: properties: accounts: $ref: '#/components/schemas/property_AccountingProfitlossSection_accounts' section_name: type: string section_type: type: string total_amount: type: number type: object AccountingProfitlossSubcategory: description: '@deprecated' properties: amount: type: number name: type: string transaction_ids: $ref: '#/components/schemas/property_AccountingProfitlossSubcategory_transaction_ids' type: object AccountingProfitlosses: items: $ref: '#/components/schemas/AccountingProfitloss' type: array AccountingPurchaseorder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingPurchaseorder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingPurchaseorder_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingPurchaseorder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: format: date-time type: string type: object AccountingPurchaseorders: items: $ref: '#/components/schemas/AccountingPurchaseorder' type: array AccountingReference: properties: id: type: string name: type: string type: object AccountingReport: description: '@deprecated; use either AccountingProfitandloss, AccountingTrialbalance, AccountingBalancesheet, or AccountingCashflow instead' properties: balance_sheet: $ref: '#/components/schemas/property_AccountingReport_balance_sheet' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string profit_and_loss: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss' raw: additionalProperties: true type: object start_at: format: date-time type: string trial_balance: $ref: '#/components/schemas/property_AccountingReport_trial_balance' type: enum: - TRIAL_BALANCE - BALANCE_SHEET - PROFIT_AND_LOSS type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AccountingReports: items: $ref: '#/components/schemas/AccountingReport' type: array AccountingSalesorder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingSalesorder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingSalesorder_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object sales_channel: type: string shipping_address: $ref: '#/components/schemas/property_AccountingSalesorder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: format: date-time type: string type: object AccountingSalesorders: items: $ref: '#/components/schemas/AccountingSalesorder' type: array AccountingTaxrate: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string organization_id: type: string rate: type: number raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object AccountingTaxrates: items: $ref: '#/components/schemas/AccountingTaxrate' type: array AccountingTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow type: object AccountingTransaction: properties: account_id: type: string contacts: $ref: '#/components/schemas/property_AccountingTransaction_contacts' created_at: format: date-time type: string currency: type: string customer_message: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingTransaction_lineitems' memo: type: string organization_id: type: string payment_method: type: string payment_terms: type: string raw: additionalProperties: true type: object reference: type: string split_account_id: type: string sub_total_amount: type: number tax_amount: type: number total_amount: type: number type: type: string updated_at: format: date-time type: string type: object AccountingTransactionContact: properties: id: type: string is_customer: type: boolean is_supplier: type: boolean required: - id type: object AccountingTransactionLineItem: properties: account_id: type: string description: type: string id: type: string name: type: string object_type: type: string total_amount: type: number unit_amount: type: number unit_quantity: type: number type: object AccountingTransactions: items: $ref: '#/components/schemas/AccountingTransaction' type: array AccountingTrialbalance: properties: created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string sub_items: $ref: '#/components/schemas/property_AccountingTrialbalance_sub_items' total_credit_amount: type: number total_debit_amount: type: number updated_at: format: date-time type: string type: object AccountingTrialbalanceSubItem: properties: account_id: type: string account_name: type: string amount: type: number type: object AccountingTrialbalances: items: $ref: '#/components/schemas/AccountingTrialbalance' type: array AdSchedule: properties: bid_modifier: type: number day_of_week: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string x-speakeasy-unknown-values: allow end_hour: type: number end_minute: type: number start_hour: type: number start_minute: type: number required: - day_of_week - start_hour - end_hour type: object AdsAd: properties: ad_copy: type: string ad_type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string creative_asset_url: type: string creative_ids: $ref: '#/components/schemas/property_AdsAd_creative_ids' cta: type: string description: type: string display_url: type: string final_url: type: string group_id: type: string headline: type: string id: type: string name: type: string organization_id: type: string path1: type: string path2: type: string promoted: $ref: '#/components/schemas/property_AdsAd_promoted' raw: additionalProperties: true type: object status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AdsAds: items: $ref: '#/components/schemas/AdsAd' type: array AdsCampaign: properties: advertising_channel_type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow budget_amount: type: number budget_period: enum: - DAILY - MONTHLY - TOTAL - LIFETIME type: string x-speakeasy-unknown-values: allow campaign_budget_identifier: type: string category: type: string created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsCampaign_frequency_cap' goal: enum: - UNSPECIFIED - BRAND_AWARENESS - REACH - WEBSITE_TRAFFIC - LEADS - SALES - APP_PROMOTION type: string x-speakeasy-unknown-values: allow has_eu_political_ads: type: boolean id: type: string name: type: string organization_id: type: string planned_spend_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow targeting: $ref: '#/components/schemas/property_AdsCampaign_targeting' total_spend_amount: type: number updated_at: format: date-time type: string type: object AdsCampaigns: items: $ref: '#/components/schemas/AdsCampaign' type: array AdsCreative: properties: asset_urls: $ref: '#/components/schemas/property_AdsCreative_asset_urls' body: type: string campaign_id: type: string created_at: format: date-time type: string creative_type: enum: - UNSPECIFIED - STANDARD - EXPANDABLE - VIDEO - NATIVE - AUDIO - PUBLISHER_HOSTED - ASSET_BASED type: string x-speakeasy-unknown-values: allow cta: type: string external_ad_reference: type: string external_creative_reference: type: string external_placement_reference: type: string group_id: type: string height: type: number hosting_source: enum: - UNSPECIFIED - CM - THIRD_PARTY - HOSTED - RICH_MEDIA - PUBLISHER_HOSTED type: string x-speakeasy-unknown-values: allow id: type: string item_id: type: string link_url: type: string name: type: string organization_id: type: string path1: type: string path2: type: string promoted: $ref: '#/components/schemas/property_AdsCreative_promoted' raw: additionalProperties: true type: object status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow third_party_tag: type: string title: type: string updated_at: format: date-time type: string vast_tag_url: type: string width: type: number type: object AdsCreatives: items: $ref: '#/components/schemas/AdsCreative' type: array AdsGroup: properties: bid_amount: type: number bid_strategy: $ref: '#/components/schemas/property_AdsGroup_bid_strategy' billing_event: enum: - IMPRESSIONS - LINK_CLICKS - VIDEO_VIEWS - APP_INSTALLS - ENGAGEMENT - PAGE_LIKES - MESSAGES - POST_ENGAGEMENT - PURCHASE - NONE type: string x-speakeasy-unknown-values: allow budget_allocation_type: enum: - UNSPECIFIED - AUTOMATIC - FIXED - UNLIMITED type: string x-speakeasy-unknown-values: allow budget_amount: type: number budget_max_amount: type: number budget_period: enum: - DAILY - MONTHLY - TOTAL - LIFETIME type: string x-speakeasy-unknown-values: allow budget_unit: enum: - UNSPECIFIED - CURRENCY - IMPRESSIONS type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string creative_ids: $ref: '#/components/schemas/property_AdsGroup_creative_ids' currency: type: string end_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsGroup_frequency_cap' has_eu_political_ads: type: boolean id: type: string insertionorder_id: type: string name: type: string optimization_goal: enum: - REACH - IMPRESSIONS - LINK_CLICKS - LANDING_PAGE_VIEWS - CONVERSIONS - LEAD_GENERATION - APP_INSTALLS - APP_ENGAGEMENT - VIDEO_VIEWS - ENGAGEMENT - PAGE_LIKES - MESSAGES type: string x-speakeasy-unknown-values: allow organization_id: type: string pacing: $ref: '#/components/schemas/property_AdsGroup_pacing' parent_id: type: string promoted: $ref: '#/components/schemas/property_AdsGroup_promoted' raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow targeting: $ref: '#/components/schemas/property_AdsGroup_targeting' type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AdsGroups: items: $ref: '#/components/schemas/AdsGroup' type: array AdsInsertionorder: properties: bid_strategy: $ref: '#/components/schemas/property_AdsInsertionorder_bid_strategy' budget_segments: $ref: '#/components/schemas/property_AdsInsertionorder_budget_segments' budget_unit: enum: - UNSPECIFIED - CURRENCY - IMPRESSIONS type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsInsertionorder_frequency_cap' id: type: string kpi: $ref: '#/components/schemas/property_AdsInsertionorder_kpi' name: type: string organization_id: type: string pacing: $ref: '#/components/schemas/property_AdsInsertionorder_pacing' raw: additionalProperties: true type: object reference: type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AdsInsertionorderBudgetSegment: properties: budget_amount: type: number description: type: string end_at: format: date-time type: string start_at: format: date-time type: string type: object AdsInsertionorders: items: $ref: '#/components/schemas/AdsInsertionorder' type: array AdsKeyword: description: Content targeting (keywords, topics, placements, video) properties: match_type: enum: - BROAD - PHRASE - EXACT type: string x-speakeasy-unknown-values: allow text: type: string required: - text type: object AdsOrganization: properties: created_at: format: date-time type: string currency: type: string id: type: string name: type: string parent_id: type: string raw: additionalProperties: true type: object timezone: type: string updated_at: format: date-time type: string type: object AdsOrganizations: items: $ref: '#/components/schemas/AdsOrganization' type: array AdsPromoted: description: Promoted entity (e.g. page, app, product, tweet) for ads create properties: id: type: string name: type: string raw: additionalProperties: true type: object type: enum: - PAGE_ID - APP_ID - STORE_URL - PIXEL_ID - CUSTOM_CONVERSION_ID - CATALOG_ID - PRODUCT_SET_ID - PRIORITIZED_SET_ID - EVENT_ID - OFFER_ID - LEAD_FORM_ID - MESSAGING_CHANNEL_ID - PRODUCT_ID - TWEET_ID - AD_GROUP_TYPE type: string x-speakeasy-unknown-values: allow required: - id - type type: object AdsPromoteds: items: $ref: '#/components/schemas/AdsPromoted' type: array AdsReport: properties: created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string metrics: $ref: '#/components/schemas/property_AdsReport_metrics' organization_id: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AdsReportMetrics: properties: ad: $ref: '#/components/schemas/property_AdsReportMetrics_ad' campaign: $ref: '#/components/schemas/property_AdsReportMetrics_campaign' group: $ref: '#/components/schemas/property_AdsReportMetrics_group' type: enum: - CLICKS - IMPRESSIONS - CONVERSIONS - COST - CTR - CPC - CONVERSION_VALUE - CPA - ROAS - CPM - ECPM - ENGAGEMENT - VIDEO_COMPLETIONS - VIDEO_VIEWS - LEADS - ENGAGEMENTS - SAVES - LIKES - SHARES - COMMENTS - FOLLOWS type: string x-speakeasy-unknown-values: allow value: type: number type: object AdsReports: items: $ref: '#/components/schemas/AdsReport' type: array AdsTarget: description: Targeting search result (for ads_target list endpoint) properties: id: type: string is_active: type: boolean name: type: string parent_id: type: string raw: additionalProperties: true type: object type: enum: - INTEREST - BEHAVIOR - LOCALE - COUNTRY - REGION - CITY - ZIP - US_DMA - TOPIC - USER_LIST - AGE_RANGE - GENDER - CARRIER - DEVICE_MODEL - OS_VERSION type: string x-speakeasy-unknown-values: allow required: - id type: object AdsTargets: items: $ref: '#/components/schemas/AdsTarget' type: array ApiCall: properties: connection_id: type: string created_at: format: date-time type: string endapi_response_time: type: number environment: default: Production type: string error: type: string external_xref: type: string id: type: string integration_type: type: string ip_address: type: string is_billable: type: boolean method: type: string name: type: string path: type: string size: type: number status: type: string type: enum: - login - webhook - inbound - mcp type: string x-speakeasy-unknown-values: allow unified_response_time: type: number user_agent: type: string webhook_id: type: string workspace_id: type: string required: - integration_type - name - path - status - type - method type: object ApiCalls: items: $ref: '#/components/schemas/ApiCall' type: array AssessmentAddress: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AssessmentAttribute: properties: label: type: string reference: type: string score_max: type: number score_value: type: number status: enum: - OPEN - IN_PROGRESS - COMPLETED - FAILED - REJECTED type: string x-speakeasy-unknown-values: allow type: enum: - TEXT - NUMBER - SUB_RESULT type: string x-speakeasy-unknown-values: allow value: type: string required: - type - label type: object AssessmentOrder: properties: application_id: type: string candidate_id: type: string company_id: type: string connection_id: type: string created_at: format: date-time type: string employee_id: type: string id: type: string job_id: type: string package_id: type: string parameters: $ref: '#/components/schemas/property_AssessmentOrder_parameters' profile_addresses: $ref: '#/components/schemas/property_AssessmentOrder_profile_addresses' profile_date_of_birth: type: string profile_emails: $ref: '#/components/schemas/property_AssessmentOrder_profile_emails' profile_first_name: type: string profile_gender: enum: - MALE - FEMALE - INTERSEX - TRANS - NON_BINARY type: string x-speakeasy-unknown-values: allow profile_ip_address: type: string profile_last_name: type: string profile_name: type: string profile_national_identifier: type: string profile_resume_url: type: string profile_social_media_urls: $ref: '#/components/schemas/property_AssessmentOrder_profile_social_media_urls' profile_telephones: $ref: '#/components/schemas/property_AssessmentOrder_profile_telephones' raw: additionalProperties: true type: object reference: type: string response_attributes: $ref: '#/components/schemas/property_AssessmentOrder_response_attributes' response_completed_at: format: date-time type: string response_details: $ref: '#/components/schemas/property_AssessmentOrder_response_details' response_download_urls: $ref: '#/components/schemas/property_AssessmentOrder_response_download_urls' response_expires_at: format: date-time type: string response_issued_at: format: date-time type: string response_max_score: type: number response_redirect_url: type: string response_score: type: number response_source: type: string response_status: enum: - OPEN - IN_PROGRESS - COMPLETED - FAILED - REJECTED type: string x-speakeasy-unknown-values: allow response_url: type: string status: enum: - OPEN - IN_PROGRESS - COMPLETED - FAILED - REJECTED type: string x-speakeasy-unknown-values: allow target_url: type: string updated_at: format: date-time type: string webhook_id: type: string workspace_id: type: string required: - workspace_id - connection_id type: object AssessmentPackage: description: Used by assessment providers to SUBMIT packages to ATS systems properties: aliases: $ref: '#/components/schemas/property_AssessmentPackage_aliases' connection_id: type: string created_at: format: date-time type: string description: type: string has_redirect_url: type: boolean has_target_url: type: boolean id: type: string info_url: type: string integration_types: $ref: '#/components/schemas/property_AssessmentPackage_integration_types' max_score: type: number name: type: string needs_ip_address: type: boolean parameters: $ref: '#/components/schemas/property_AssessmentPackage_parameters' raw: additionalProperties: true type: object regions: $ref: '#/components/schemas/property_AssessmentPackage_regions' tags: $ref: '#/components/schemas/property_AssessmentPackage_tags' type: enum: - SKILLS_TEST - BEHAVIORAL_ASSESSMENT - VIDEO_INTERVIEW - BACKGROUND_CHECK - REFERENCE_CHECK - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string workspace_id: type: string required: - id - name - type type: object AssessmentPackageRegion: properties: cost_amount: type: number currency: type: string processing_time: type: number regions: $ref: '#/components/schemas/property_AssessmentPackageRegion_regions' required: - regions - cost_amount type: object AssessmentPackages: items: $ref: '#/components/schemas/AssessmentPackage' type: array AssessmentParameter: properties: file_types: $ref: '#/components/schemas/property_AssessmentParameter_file_types' id: type: string is_required: type: boolean name: type: string options: $ref: '#/components/schemas/property_AssessmentParameter_options' public_question: type: string type: enum: - TEXT - NUMBER - MULTIPLE_CHOICE - MULTIPLE_SELECT - DATE - FILE type: string x-speakeasy-unknown-values: allow valid_regions: $ref: '#/components/schemas/property_AssessmentParameter_valid_regions' required: - name type: object AssessmentParameterInput: properties: inputs: $ref: '#/components/schemas/property_AssessmentParameterInput_inputs' name: type: string parameter_id: type: string type: object AssessmentResponseDetail: properties: download_url: type: string is_failed_reason: type: boolean is_private: type: boolean parameter_id: type: string text: type: string title: type: string type: object AtsActivities: items: $ref: '#/components/schemas/AtsActivity' type: array AtsActivity: properties: application_id: type: string bcc: $ref: '#/components/schemas/property_AtsActivity_bcc' candidate_id: type: string cc: $ref: '#/components/schemas/property_AtsActivity_cc' created_at: format: date-time type: string description: type: string document_ids: $ref: '#/components/schemas/property_AtsActivity_document_ids' from: $ref: '#/components/schemas/property_AtsActivity_from' id: type: string interview_id: type: string is_private: type: boolean job_id: type: string raw: additionalProperties: true type: object sub_type: type: string title: type: string to: $ref: '#/components/schemas/property_AtsActivity_to' type: enum: - NOTE - TASK - EMAIL type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_AtsActivity_user_ids' type: object AtsAddress: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AtsApplication: properties: answers: $ref: '#/components/schemas/property_AtsApplication_answers' applied_at: format: date-time type: string candidate_id: type: string created_at: format: date-time type: string hired_at: format: date-time type: string id: type: string job_id: type: string metadata: $ref: '#/components/schemas/property_AtsApplication_metadata' offers: $ref: '#/components/schemas/property_AtsApplication_offers' original_status: type: string raw: additionalProperties: true type: object rejected_at: format: date-time type: string rejected_reason: type: string source: type: string status: enum: - NEW - REVIEWING - SCREENING - SUBMITTED - FIRST_INTERVIEW - SECOND_INTERVIEW - THIRD_INTERVIEW - BACKGROUND_CHECK - OFFERED - ACCEPTED - HIRED - REJECTED - DECLINED - WITHDRAWN type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object AtsApplicationAnswer: properties: answers: $ref: '#/components/schemas/property_AtsApplicationAnswer_answers' question: type: string question_id: type: string required: - question_id - answers type: object AtsApplications: items: $ref: '#/components/schemas/AtsApplication' type: array AtsCandidate: properties: address: $ref: '#/components/schemas/property_AtsCandidate_address' company_id: type: string company_name: type: string created_at: format: date-time type: string date_of_birth: format: date-time type: string education: $ref: '#/components/schemas/property_AtsCandidate_education' emails: $ref: '#/components/schemas/property_AtsCandidate_emails' experiences: $ref: '#/components/schemas/property_AtsCandidate_experiences' external_identifier: type: string first_name: type: string id: type: string image_url: type: string last_name: type: string link_urls: $ref: '#/components/schemas/property_AtsCandidate_link_urls' metadata: $ref: '#/components/schemas/property_AtsCandidate_metadata' name: type: string origin: enum: - AGENCY - APPLIED - INTERNAL - REFERRED - SOURCED - UNIVERSITY type: string x-speakeasy-unknown-values: allow raw: additionalProperties: true type: object skills: $ref: '#/components/schemas/property_AtsCandidate_skills' sources: $ref: '#/components/schemas/property_AtsCandidate_sources' tags: $ref: '#/components/schemas/property_AtsCandidate_tags' telephones: $ref: '#/components/schemas/property_AtsCandidate_telephones' title: type: string updated_at: format: date-time type: string user_id: type: string web_url: type: string type: object AtsCandidateEducation: properties: degree: type: string end_at: format: date-time type: string field_of_study: type: string institution: type: string level: type: string start_at: format: date-time type: string type: object AtsCandidateExperience: properties: company_name: type: string end_at: format: date-time type: string start_at: format: date-time type: string title: type: string type: object AtsCandidates: items: $ref: '#/components/schemas/AtsCandidate' type: array AtsCompanies: items: $ref: '#/components/schemas/AtsCompany' type: array AtsCompany: properties: address: $ref: '#/components/schemas/property_AtsCompany_address' created_at: format: date-time type: string id: type: string metadata: $ref: '#/components/schemas/property_AtsCompany_metadata' name: type: string parent_id: type: string phone: type: string raw: additionalProperties: true type: object recruiter_ids: $ref: '#/components/schemas/property_AtsCompany_recruiter_ids' updated_at: format: date-time type: string website_url: type: string required: - name type: object AtsCompensation: properties: currency: type: string frequency: enum: - ONE_TIME - DAY - QUARTER - YEAR - HOUR - MONTH - WEEK type: string x-speakeasy-unknown-values: allow max: type: number min: type: number type: enum: - SALARY - BONUS - STOCK_OPTIONS - EQUITY - OTHER type: string x-speakeasy-unknown-values: allow type: object AtsDocument: properties: application_id: type: string candidate_id: type: string created_at: format: date-time type: string document_data: type: string document_url: type: string filename: type: string id: type: string job_id: type: string raw: additionalProperties: true type: object type: enum: - RESUME - COVER_LETTER - OFFER_PACKET - OFFER_LETTER - TAKE_HOME_TEST - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object AtsDocuments: items: $ref: '#/components/schemas/AtsDocument' type: array AtsEmail: properties: email: type: string name: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object AtsGroup: properties: id: type: string name: type: string type: enum: - TEAM - GROUP - DEPARTMENT - DIVISION - BUSINESS_UNIT - BRANCH - SUB_DEPARTMENT type: string x-speakeasy-unknown-values: allow type: object AtsInterview: properties: application_id: type: string candidate_id: type: string created_at: format: date-time type: string end_at: format: date-time type: string external_event_xref: type: string id: type: string job_id: type: string location: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - SCHEDULED - AWAITING_FEEDBACK - COMPLETE - CANCELED - NEEDS_SCHEDULING type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_AtsInterview_user_ids' type: object AtsInterviews: items: $ref: '#/components/schemas/AtsInterview' type: array AtsJob: properties: addresses: $ref: '#/components/schemas/property_AtsJob_addresses' closed_at: format: date-time type: string company_id: type: string compensation: $ref: '#/components/schemas/property_AtsJob_compensation' created_at: format: date-time type: string description: type: string employment_type: enum: - FULL_TIME - PART_TIME - CONTRACTOR - INTERN - CONSULTANT - VOLUNTEER - CASUAL - SEASONAL - FREELANCE - OTHER type: string x-speakeasy-unknown-values: allow groups: $ref: '#/components/schemas/property_AtsJob_groups' hiring_manager_ids: $ref: '#/components/schemas/property_AtsJob_hiring_manager_ids' hiring_managers: $ref: '#/components/schemas/property_AtsJob_hiring_managers' id: type: string language_locale: type: string metadata: $ref: '#/components/schemas/property_AtsJob_metadata' minimum_degree: type: string minimum_experience_years: type: number name: type: string number_of_openings: type: number openings: $ref: '#/components/schemas/property_AtsJob_openings' postings: $ref: '#/components/schemas/property_AtsJob_postings' public_job_urls: $ref: '#/components/schemas/property_AtsJob_public_job_urls' questions: $ref: '#/components/schemas/property_AtsJob_questions' raw: additionalProperties: true type: object recruiter_ids: $ref: '#/components/schemas/property_AtsJob_recruiter_ids' remote: type: boolean skills: $ref: '#/components/schemas/property_AtsJob_skills' status: enum: - ARCHIVED - PENDING - DRAFT - OPEN - CLOSED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AtsJobOpening: properties: application_id: type: string close_reason: type: string closed_at: format: date-time type: string opened_at: format: date-time type: string status: enum: - OPEN - CLOSED type: string x-speakeasy-unknown-values: allow type: object AtsJobPosting: properties: address: $ref: '#/components/schemas/property_AtsJobPosting_address' created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean location: type: string name: type: string posting_url: type: string updated_at: format: date-time type: string type: object AtsJobQuestion: properties: description: type: string id: type: string options: $ref: '#/components/schemas/property_AtsJobQuestion_options' prompt: type: string question: type: string required: type: boolean type: enum: - TEXT - NUMBER - DATE - BOOLEAN - MULTIPLE_CHOICE - FILE - TEXTAREA - MULTIPLE_SELECT - UNIVERSITY - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow required: - question - type type: object AtsJobs: items: $ref: '#/components/schemas/AtsJob' type: array AtsMetadata: properties: extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string namespace: type: string slug: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object AtsOffer: properties: accepted_at: format: date-time type: string compensation: $ref: '#/components/schemas/property_AtsOffer_compensation' created_at: format: date-time type: string creator_user_id: type: string employee_user_id: type: string id: type: string raw: additionalProperties: true type: object rejected_at: format: date-time type: string sent_at: format: date-time type: string start_at: format: date-time type: string status: enum: - CREATED - SENT - ACCEPTED - REJECTED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AtsReference: properties: id: type: string name: type: string type: object AtsScorecard: properties: application_id: type: string candidate_id: type: string comment: type: string created_at: format: date-time type: string id: type: string interview_id: type: string interviewer_id: type: string job_id: type: string questions: $ref: '#/components/schemas/property_AtsScorecard_questions' raw: additionalProperties: true type: object recommendation: enum: - DEFINITELY_NO - 'NO' - 'YES' - STRONG_YES type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object AtsScorecardQuestion: properties: answer: type: string description: type: string text: type: string required: - text type: object AtsScorecards: items: $ref: '#/components/schemas/AtsScorecard' type: array AtsStatus: properties: description: type: string id: type: string original_status: type: string raw: additionalProperties: true type: object status: enum: - NEW - REVIEWING - SCREENING - SUBMITTED - FIRST_INTERVIEW - SECOND_INTERVIEW - THIRD_INTERVIEW - BACKGROUND_CHECK - OFFERED - ACCEPTED - HIRED - REJECTED - DECLINED - WITHDRAWN type: string x-speakeasy-unknown-values: allow type: object AtsStatuses: items: $ref: '#/components/schemas/AtsStatus' type: array AtsTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object AudienceCombination: properties: behaviors: $ref: '#/components/schemas/property_AudienceCombination_behaviors' demographics: $ref: '#/components/schemas/property_AudienceCombination_demographics' interests: $ref: '#/components/schemas/property_AudienceCombination_interests' life_events: $ref: '#/components/schemas/property_AudienceCombination_life_events' type: object AudienceSegment: description: 'Audience targeting (Meta: custom_audiences, lookalike_audiences, flexible_spec)' properties: id: type: string name: type: string required: - id type: object CalendarAttachment: properties: download_url: type: string id: type: string mime_type: type: string name: type: string type: object CalendarAttendee: properties: email: type: string is_cohost: type: boolean name: type: string required: type: boolean status: enum: - ACCEPTED - REJECTED - TENTATIVE type: string x-speakeasy-unknown-values: allow user_id: type: string type: object CalendarBusies: items: $ref: '#/components/schemas/CalendarBusy' type: array CalendarBusy: properties: description: type: string end_at: format: date-time type: string id: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string timezone: type: string required: - start_at - end_at type: object CalendarCalendar: properties: created_at: format: date-time type: string description: type: string id: type: string is_primary: type: boolean name: type: string raw: additionalProperties: true type: object timezone: type: string updated_at: format: date-time type: string required: - name type: object CalendarCalendars: items: $ref: '#/components/schemas/CalendarCalendar' type: array CalendarConference: properties: conference_identifier: type: string country_code: type: string host_access_code: type: string label: type: string notes: type: string participant_access_code: type: string region_code: type: string telephone: type: string url: type: string type: object CalendarEvent: properties: attachments: $ref: '#/components/schemas/property_CalendarEvent_attachments' attendees: $ref: '#/components/schemas/property_CalendarEvent_attendees' calendar_id: type: string conference: $ref: '#/components/schemas/property_CalendarEvent_conference' created_at: type: string end_at: type: string has_conference: type: boolean id: type: string is_all_day: type: boolean is_free: type: boolean is_private: type: boolean location: type: string notes: type: string organizer: $ref: '#/components/schemas/property_CalendarEvent_organizer' raw: additionalProperties: true type: object recurrence: $ref: '#/components/schemas/property_CalendarEvent_recurrence' recurring_event_id: type: string send_notifications: type: boolean start_at: type: string status: enum: - CANCELED - CONFIRMED - TENTATIVE type: string x-speakeasy-unknown-values: allow subject: type: string timezone: type: string updated_at: type: string web_url: type: string type: object CalendarEventRecurrence: properties: count: type: number end_at: format: date-time type: string excluded_dates: $ref: '#/components/schemas/property_CalendarEventRecurrence_excluded_dates' frequency: enum: - DAILY - WEEKLY - MONTHLY - YEARLY type: string x-speakeasy-unknown-values: allow included_dates: $ref: '#/components/schemas/property_CalendarEventRecurrence_included_dates' interval: type: number on_days: $ref: '#/components/schemas/property_CalendarEventRecurrence_on_days' on_month_days: $ref: '#/components/schemas/property_CalendarEventRecurrence_on_month_days' on_months: $ref: '#/components/schemas/property_CalendarEventRecurrence_on_months' on_weeks: $ref: '#/components/schemas/property_CalendarEventRecurrence_on_weeks' on_year_days: $ref: '#/components/schemas/property_CalendarEventRecurrence_on_year_days' timezone: type: string week_start: enum: - SU - MO - TU - WE - TH - FR - SA type: string x-speakeasy-unknown-values: allow type: object CalendarEvents: items: $ref: '#/components/schemas/CalendarEvent' type: array CalendarLink: properties: created_at: type: string description: type: string duration: type: number id: type: string is_active: type: boolean name: type: string price_amount: type: number price_currency: type: string raw: additionalProperties: true type: object updated_at: type: string url: type: string required: - url type: object CalendarLinks: items: $ref: '#/components/schemas/CalendarLink' type: array CalendarRecording: properties: created_at: format: date-time type: string end_at: format: date-time type: string event_id: type: string expires_at: format: date-time type: string id: type: string media: $ref: '#/components/schemas/property_CalendarRecording_media' raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string web_url: type: string type: object CalendarRecordingMedia: properties: attendees: $ref: '#/components/schemas/property_CalendarRecordingMedia_attendees' end_at: format: date-time type: string language: type: string recording_download_url: type: string start_at: format: date-time type: string transcript_download_url: type: string transcripts: $ref: '#/components/schemas/property_CalendarRecordingMedia_transcripts' type: object CalendarRecordingTranscript: properties: attendee: $ref: '#/components/schemas/property_CalendarRecordingTranscript_attendee' end_at: format: date-time type: string language: type: string start_at: format: date-time type: string text: type: string required: - text type: object CalendarRecordings: items: $ref: '#/components/schemas/CalendarRecording' type: array CalendarWebinar: properties: calendar_id: type: string capacity: type: number conference: $ref: '#/components/schemas/property_CalendarWebinar_conference' created_at: format: date-time type: string end_at: format: date-time type: string has_polls: type: boolean has_qa: type: boolean has_recording: type: boolean id: type: string is_auto_approve: type: boolean is_enabled: type: boolean is_webcast: type: boolean join_url: type: string notes: type: string organizer: $ref: '#/components/schemas/property_CalendarWebinar_organizer' panelist_password: type: string panelists: $ref: '#/components/schemas/property_CalendarWebinar_panelists' raw: additionalProperties: true type: object recurrence: $ref: '#/components/schemas/property_CalendarWebinar_recurrence' registrant_password: type: string registrants: $ref: '#/components/schemas/property_CalendarWebinar_registrants' require_address: type: boolean require_company: type: boolean require_email: type: boolean require_first_name: type: boolean require_job_title: type: boolean require_last_name: type: boolean require_phone: type: boolean start_at: format: date-time type: string status: enum: - CANCELED - CONFIRMED - TENTATIVE type: string x-speakeasy-unknown-values: allow subject: type: string timezone: type: string updated_at: format: date-time type: string web_url: type: string type: object CalendarWebinarPanelist: properties: email: type: string is_required: type: boolean join_password: type: string join_url: type: string name: type: string status: enum: - ACCEPTED - REJECTED - TENTATIVE type: string x-speakeasy-unknown-values: allow type: object CalendarWebinarRegistrant: properties: email: type: string name: type: string registered_at: format: date-time type: string registration_reference: type: string registration_status: enum: - PENDING - APPROVED - REJECTED - CANCELLED type: string x-speakeasy-unknown-values: allow type: object CalendarWebinars: items: $ref: '#/components/schemas/CalendarWebinar' type: array CityTarget: properties: id: type: string name: type: string radius: type: number radius_unit: enum: - MILES - KILOMETERS type: string x-speakeasy-unknown-values: allow required: - id type: object CommerceAvailabilities: items: $ref: '#/components/schemas/CommerceAvailability' type: array CommerceAvailability: properties: end_at: format: date-time type: string item_id: type: string location_id: type: string raw: additionalProperties: true type: object size: type: number staff_user_id: type: string start_at: format: date-time type: string type: object CommerceCollection: description: A collection of items/products/services properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean is_featured: type: boolean is_visible: type: boolean item_metadata: $ref: '#/components/schemas/property_CommerceCollection_item_metadata' media: $ref: '#/components/schemas/property_CommerceCollection_media' metadata: $ref: '#/components/schemas/property_CommerceCollection_metadata' name: type: string parent_id: type: string public_description: type: string public_name: type: string raw: additionalProperties: true type: object tags: $ref: '#/components/schemas/property_CommerceCollection_tags' type: enum: - COLLECTION - SAVED_SEARCH - CATEGORY type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string required: - name type: object CommerceCollections: items: $ref: '#/components/schemas/CommerceCollection' type: array CommerceInventories: items: $ref: '#/components/schemas/CommerceInventory' type: array CommerceInventory: properties: available: type: number id: type: string item_id: type: string item_option_id: type: string item_variant_id: type: string location_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string required: - available type: object CommerceItem: properties: account_id: type: string collection_ids: $ref: '#/components/schemas/property_CommerceItem_collection_ids' collections: $ref: '#/components/schemas/property_CommerceItem_collections' created_at: format: date-time type: string description: type: string duration: type: number global_code: type: string id: type: string inventory_id: type: string is_active: type: boolean is_featured: type: boolean is_taxable: type: boolean is_visible: type: boolean location_id: type: string media: $ref: '#/components/schemas/property_CommerceItem_media' metadata: $ref: '#/components/schemas/property_CommerceItem_metadata' name: type: string prices: $ref: '#/components/schemas/property_CommerceItem_prices' public_description: type: string public_name: type: string raw: additionalProperties: true type: object requires_shipping: type: boolean slug: type: string tags: $ref: '#/components/schemas/property_CommerceItem_tags' taxrate_id: type: string total_stock: type: number type: type: string updated_at: format: date-time type: string variants: $ref: '#/components/schemas/property_CommerceItem_variants' vendor_name: type: string weight: type: number weight_unit: enum: - g - kg - oz - lb type: string x-speakeasy-unknown-values: allow type: object CommerceItemMedia: properties: alt: type: string height: type: number id: type: string metadata: $ref: '#/components/schemas/property_CommerceItemMedia_metadata' position: type: number type: enum: - image - video type: string x-speakeasy-unknown-values: allow url: type: string width: type: number required: - url type: object CommerceItemOption: properties: id: type: string name: type: string position: type: number values: $ref: '#/components/schemas/property_CommerceItemOption_values' required: - name - values type: object CommerceItemPrice: properties: compare_at_price: type: number currency: type: string price: type: number required: - price type: object CommerceItems: items: $ref: '#/components/schemas/CommerceItem' type: array CommerceItemvariant: properties: available_at: format: date-time type: string created_at: format: date-time type: string description: type: string height: type: number id: type: string inventory_id: type: string is_active: type: boolean is_featured: type: boolean is_visible: type: boolean items: $ref: '#/components/schemas/property_CommerceItemvariant_items' length: type: number media: $ref: '#/components/schemas/property_CommerceItemvariant_media' metadata: $ref: '#/components/schemas/property_CommerceItemvariant_metadata' name: type: string options: $ref: '#/components/schemas/property_CommerceItemvariant_options' prices: $ref: '#/components/schemas/property_CommerceItemvariant_prices' public_description: type: string public_name: type: string raw: additionalProperties: true type: object requires_shipping: type: boolean size_unit: enum: - cm - inch type: string x-speakeasy-unknown-values: allow sku: type: string tags: $ref: '#/components/schemas/property_CommerceItemvariant_tags' total_stock: type: number updated_at: format: date-time type: string weight: type: number weight_unit: enum: - g - kg - oz - lb type: string x-speakeasy-unknown-values: allow width: type: number type: object CommerceItemvariants: items: $ref: '#/components/schemas/CommerceItemvariant' type: array CommerceLocation: properties: address: $ref: '#/components/schemas/property_CommerceLocation_address' categories: $ref: '#/components/schemas/property_CommerceLocation_categories' created_at: format: date-time type: string currency: type: string description: type: string id: type: string image_url: type: string is_active: type: boolean language_locale: type: string latitude: type: number location_type: enum: - RESTAURANT - SALON - WAREHOUSE - STORE - OTHER type: string x-speakeasy-unknown-values: allow longitude: type: number media: $ref: '#/components/schemas/property_CommerceLocation_media' name: type: string parent_id: type: string price_level: type: string rating: type: number raw: additionalProperties: true type: object review_count: type: number telephones: $ref: '#/components/schemas/property_CommerceLocation_telephones' updated_at: format: date-time type: string web_url: type: string required: - name type: object CommerceLocations: items: $ref: '#/components/schemas/CommerceLocation' type: array CommerceMetadata: properties: description: type: string extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string is_required: type: boolean namespace: type: string slug: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object CommerceReference: properties: id: type: string name: type: string type: type: string type: object CommerceReservation: properties: created_at: format: date-time type: string end_at: format: date-time type: string guest_email: type: string guest_name: type: string guest_phone: type: string id: type: string item_id: type: string item_name: type: string location_id: type: string notes: type: string raw: additionalProperties: true type: object size: type: number staff_name: type: string staff_user_id: type: string start_at: format: date-time type: string status: enum: - PENDING - CONFIRMED - CANCELLED - NO_SHOW - COMPLETED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string url: type: string type: object CommerceReservations: items: $ref: '#/components/schemas/CommerceReservation' type: array CommerceReview: properties: author_avatar_url: type: string author_email: type: string author_location: type: string author_name: type: string comments: $ref: '#/components/schemas/property_CommerceReview_comments' content: type: string created_at: format: date-time type: string helpful_votes: type: number id: type: string is_featured: type: boolean is_public: type: boolean is_verified: type: boolean item_id: type: string item_variant_id: type: string location_id: type: string media: $ref: '#/components/schemas/property_CommerceReview_media' metadata: $ref: '#/components/schemas/property_CommerceReview_metadata' rating: type: number raw: additionalProperties: true type: object status: enum: - PENDING - APPROVED - REJECTED - SPAM type: string x-speakeasy-unknown-values: allow title: type: string unhelpful_votes: type: number updated_at: format: date-time type: string url: type: string verified_purchase: type: boolean required: - item_id type: object CommerceReviewComment: properties: author_avatar_url: type: string author_email: type: string author_location: type: string author_name: type: string content: type: string created_at: format: date-time type: string helpful_votes: type: number id: type: string is_public: type: boolean is_verified: type: boolean metadata: $ref: '#/components/schemas/property_CommerceReviewComment_metadata' raw: additionalProperties: true type: object status: enum: - PENDING - APPROVED - REJECTED - SPAM type: string x-speakeasy-unknown-values: allow unhelpful_votes: type: number updated_at: format: date-time type: string required: - content type: object CommerceReviews: items: $ref: '#/components/schemas/CommerceReview' type: array CommerceSaleschannel: properties: collections: $ref: '#/components/schemas/property_CommerceSaleschannel_collections' created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean raw: additionalProperties: true type: object slug: type: string updated_at: format: date-time type: string type: object CommerceSaleschannels: items: $ref: '#/components/schemas/CommerceSaleschannel' type: array CommerceTelephone: properties: telephone: type: string type: enum: - WORK - HOME - FAX - MOBILE - OTHER type: string x-speakeasy-unknown-values: allow required: - telephone type: object Connection: description: A connection represents a specific authentication of an integration. properties: auth: $ref: '#/components/schemas/property_Connection_auth' auth_aws_arn: type: string auth_azure_keyvault_id: type: string auth_gcp_secret_name: type: string auth_hashi_vault_path: type: string categories: $ref: '#/components/schemas/property_Connection_categories' created_at: format: date-time type: string environment: default: Production type: string external_xref: type: string id: type: string integration_name: type: string integration_type: type: string is_paused: type: boolean last_healthy_at: format: date-time type: string last_unhealthy_at: format: date-time type: string permissions: $ref: '#/components/schemas/property_Connection_permissions' updated_at: format: date-time type: string workspace_id: type: string required: - integration_type - permissions - categories type: object Connections: items: $ref: '#/components/schemas/Connection' type: array CrmCompanies: items: $ref: '#/components/schemas/CrmCompany' type: array CrmCompany: description: A company represents an organization that optionally is associated with a deal and/or contacts properties: address: $ref: '#/components/schemas/property_CrmCompany_address' contact_ids: $ref: '#/components/schemas/property_CrmCompany_contact_ids' created_at: format: date-time type: string deal_ids: $ref: '#/components/schemas/property_CrmCompany_deal_ids' description: type: string domains: $ref: '#/components/schemas/property_CrmCompany_domains' emails: $ref: '#/components/schemas/property_CrmCompany_emails' employees: type: number id: type: string industry: type: string is_active: type: boolean link_urls: $ref: '#/components/schemas/property_CrmCompany_link_urls' metadata: $ref: '#/components/schemas/property_CrmCompany_metadata' name: type: string raw: additionalProperties: true type: object tags: $ref: '#/components/schemas/property_CrmCompany_tags' telephones: $ref: '#/components/schemas/property_CrmCompany_telephones' timezone: type: string updated_at: format: date-time type: string user_id: type: string websites: $ref: '#/components/schemas/property_CrmCompany_websites' type: object CrmContact: description: A contact represents a person that optionally is associated with a deal and/or a company properties: address: $ref: '#/components/schemas/property_CrmContact_address' company: type: string company_ids: $ref: '#/components/schemas/property_CrmContact_company_ids' created_at: format: date-time type: string deal_ids: $ref: '#/components/schemas/property_CrmContact_deal_ids' department: type: string emails: $ref: '#/components/schemas/property_CrmContact_emails' first_name: type: string id: type: string image_url: type: string last_name: type: string link_urls: $ref: '#/components/schemas/property_CrmContact_link_urls' metadata: $ref: '#/components/schemas/property_CrmContact_metadata' name: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_CrmContact_telephones' title: type: string updated_at: format: date-time type: string user_id: type: string type: object CrmContacts: items: $ref: '#/components/schemas/CrmContact' type: array CrmDeal: description: A deal represents an opportunity with companies and/or contacts properties: amount: type: number closed_at: format: date-time type: string closing_at: format: date-time type: string company_ids: $ref: '#/components/schemas/property_CrmDeal_company_ids' contact_ids: $ref: '#/components/schemas/property_CrmDeal_contact_ids' created_at: format: date-time type: string currency: type: string id: type: string lost_reason: type: string metadata: $ref: '#/components/schemas/property_CrmDeal_metadata' name: type: string pipeline: type: string pipeline_id: type: string pipelines: $ref: '#/components/schemas/property_CrmDeal_pipelines' probability: type: number raw: additionalProperties: true type: object source: type: string stage: type: string stage_id: type: string stages: $ref: '#/components/schemas/property_CrmDeal_stages' tags: $ref: '#/components/schemas/property_CrmDeal_tags' updated_at: format: date-time type: string user_id: type: string won_reason: type: string type: object CrmDeals: items: $ref: '#/components/schemas/CrmDeal' type: array CrmEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow type: object CrmEvent: description: An event represents an event, activity, or engagement and is always associated with a deal, contact, or company properties: call: $ref: '#/components/schemas/property_CrmEvent_call' company_ids: $ref: '#/components/schemas/property_CrmEvent_company_ids' contact_ids: $ref: '#/components/schemas/property_CrmEvent_contact_ids' created_at: format: date-time type: string deal_ids: $ref: '#/components/schemas/property_CrmEvent_deal_ids' email: $ref: '#/components/schemas/property_CrmEvent_email' form: $ref: '#/components/schemas/property_CrmEvent_form' id: type: string lead_ids: $ref: '#/components/schemas/property_CrmEvent_lead_ids' marketing_email: $ref: '#/components/schemas/property_CrmEvent_marketing_email' meeting: $ref: '#/components/schemas/property_CrmEvent_meeting' note: $ref: '#/components/schemas/property_CrmEvent_note' page_view: $ref: '#/components/schemas/property_CrmEvent_page_view' raw: additionalProperties: true type: object task: $ref: '#/components/schemas/property_CrmEvent_task' type: enum: - NOTE - EMAIL - TASK - MEETING - CALL - MARKETING_EMAIL - FORM - PAGE_VIEW type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object CrmEventFormField: properties: name: type: string options: $ref: '#/components/schemas/property_CrmEventFormField_options' required: type: boolean type: enum: - TEXT - NUMBER - DATE - BOOLEAN - MULTIPLE_CHOICE - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - EMAIL - PHONE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow type: object CrmEventFormOption: properties: label: type: string value: type: string type: object CrmEvents: items: $ref: '#/components/schemas/CrmEvent' type: array CrmLead: properties: address: $ref: '#/components/schemas/property_CrmLead_address' company_id: type: string company_name: type: string contact_id: type: string created_at: format: date-time type: string creator_user_id: type: string emails: $ref: '#/components/schemas/property_CrmLead_emails' first_name: type: string id: type: string is_active: type: boolean last_name: type: string link_urls: $ref: '#/components/schemas/property_CrmLead_link_urls' metadata: $ref: '#/components/schemas/property_CrmLead_metadata' name: type: string raw: additionalProperties: true type: object source: type: string status: type: string telephones: $ref: '#/components/schemas/property_CrmLead_telephones' updated_at: format: date-time type: string user_id: type: string type: object CrmLeads: items: $ref: '#/components/schemas/CrmLead' type: array CrmMetadata: properties: extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string namespace: type: string slug: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object CrmPipeline: properties: created_at: format: date-time type: string deal_probability: type: number display_order: type: number id: type: string is_active: type: boolean name: type: string raw: additionalProperties: true type: object stages: $ref: '#/components/schemas/property_CrmPipeline_stages' updated_at: format: date-time type: string type: object CrmPipelines: items: $ref: '#/components/schemas/CrmPipeline' type: array CrmReference: properties: id: type: string name: type: string type: type: string type: object CrmStage: properties: active: type: boolean created_at: format: date-time type: string deal_probability: type: number display_order: type: number id: type: string is_closed: type: boolean name: type: string updated_at: format: date-time type: string type: object CrmTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object EnrichCompany: description: A company object from an enrichment integration properties: address: $ref: '#/components/schemas/property_EnrichCompany_address' alexa_rank: type: number created_at: format: date-time type: string crunchbase_url: type: string description: type: string domain: type: string employees: type: string exchange: type: string facebook_url: type: string id: type: string industry: type: string instagram_url: type: string linkedin_url: type: string logo_url: type: string naics_code: type: number name: type: string raw: additionalProperties: true type: object revenue: type: string sic_code: type: number stock: type: string telephones: $ref: '#/components/schemas/property_EnrichCompany_telephones' twitter_handle: type: string twitter_url: type: string updated_at: format: date-time type: string year_founded: type: number yelp_url: type: string youtube_url: type: string type: object EnrichEmail: properties: email: type: string is_verified: type: boolean type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object EnrichPerson: description: A person object from an enrichment integration properties: address: $ref: '#/components/schemas/property_EnrichPerson_address' bio: type: string birthdate: type: string company: type: string company_domain: type: string created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_EnrichPerson_emails' facebook_url: type: string first_name: type: string gender: enum: - MALE - FEMALE type: string x-speakeasy-unknown-values: allow github_url: type: string github_username: type: string id: type: string image_url: type: string last_name: type: string linkedin_url: type: string name: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_EnrichPerson_telephones' timezone: type: string title: type: string twitter_handle: type: string twitter_url: type: string updated_at: format: date-time type: string utc_offset: type: number work_histories: $ref: '#/components/schemas/property_EnrichPerson_work_histories' type: object EnrichPersonWorkHistory: properties: company_domain: type: string company_id: type: string company_name: type: string end_at: format: date-time type: string location: type: string start_at: format: date-time type: string title: type: string required: - title type: object EnrichTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object Environments: description: A list of environments in the workspace. items: type: string type: array FormAnswer: properties: field_id: type: string field_name: type: string file_ids: $ref: '#/components/schemas/property_FormAnswer_file_ids' value: type: string required: - field_id type: object FormField: properties: choices: $ref: '#/components/schemas/property_FormField_choices' created_at: format: date-time type: string default_value: type: string description: type: string id: type: string is_active: type: boolean is_required: type: boolean max: type: number max_length: type: number min: type: number min_length: type: number name: type: string order: type: number pattern: type: string type: enum: - TEXT - TEXTAREA - NUMBER - EMAIL - URL - DATE - TIME - DATETIME - PHONE - BOOLEAN - SINGLE_SELECT - MULTIPLE_SELECT - FILE_UPLOAD - RATING - SCALE - MATRIX - SECTION_HEADER - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string required: - name - type type: object FormsForm: properties: confirmation_message: type: string confirmation_redirect_url: type: string created_at: format: date-time type: string description: type: string fields: $ref: '#/components/schemas/property_FormsForm_fields' has_multiple_submissions: type: boolean has_progress_bar: type: boolean has_shuffle_questions: type: boolean id: type: string is_active: type: boolean name: type: string published_url: type: string raw: additionalProperties: true type: object response_count: type: number updated_at: format: date-time type: string required: - name type: object FormsForms: items: $ref: '#/components/schemas/FormsForm' type: array FormsSubmission: properties: answers: $ref: '#/components/schemas/property_FormsSubmission_answers' created_at: format: date-time type: string form_id: type: string id: type: string raw: additionalProperties: true type: object respondent_email: type: string respondent_name: type: string updated_at: format: date-time type: string required: - form_id - answers type: object FormsSubmissions: items: $ref: '#/components/schemas/FormsSubmission' type: array GenaiContent: properties: content: type: string role: enum: - SYSTEM - USER - ASSISTANT type: string x-speakeasy-unknown-values: allow required: - content type: object GenaiEmbedding: properties: content: $ref: '#/components/schemas/property_GenaiEmbedding_content' dimension: type: number embeddings: type: string enconding_format: enum: - FLOAT - UINT8 - INT8 - BINARY - UBINARY - BASE64 type: string x-speakeasy-unknown-values: allow id: type: string max_tokens: type: number model_id: type: string raw: additionalProperties: true type: object tokens_used: type: number type: type: string type: object GenaiEmbeddingContent: properties: text: type: string required: - text type: object GenaiModel: properties: description: type: string has_temperature: type: boolean id: type: string max_tokens: type: number name: type: string raw: additionalProperties: true type: object web_url: type: string type: object GenaiModels: items: $ref: '#/components/schemas/GenaiModel' type: array GenaiPrompt: properties: max_tokens: type: number mcp_authorization_token: type: string mcp_deferred_tools: $ref: '#/components/schemas/property_GenaiPrompt_mcp_deferred_tools' mcp_url: type: string messages: $ref: '#/components/schemas/property_GenaiPrompt_messages' model_id: type: string raw: additionalProperties: true type: object responses: $ref: '#/components/schemas/property_GenaiPrompt_responses' temperature: type: number tokens_used: type: number type: object HrisBankaccount: properties: account_number: type: string account_number_last4: type: string account_type: enum: - CHECKING - SAVINGS type: string x-speakeasy-unknown-values: allow bank_name: type: string company_id: type: string created_at: format: date-time type: string id: type: string is_primary: type: boolean name: type: string raw: additionalProperties: true type: object routing_number: type: string updated_at: format: date-time type: string user_id: type: string type: object HrisBankaccounts: items: $ref: '#/components/schemas/HrisBankaccount' type: array HrisBenefit: description: Company-wide benefit plans available to employees. properties: company_id: type: string coverage_level: enum: - EMPLOYEE_ONLY - EMPLOYEE_SPOUSE - EMPLOYEE_CHILD - EMPLOYEE_CHILDREN - EMPLOYEE_FAMILY - FAMILY - OTHER type: string x-speakeasy-unknown-values: allow created_at: format: date-time type: string currency: type: string description: type: string employer_contribution_amount: type: number employer_contribution_max_amount: type: number employer_contribution_type: enum: - PERCENTAGE - FIXED type: string x-speakeasy-unknown-values: allow frequency: enum: - ONE_TIME - DAY - QUARTER - YEAR - HOUR - MONTH - WEEK type: string x-speakeasy-unknown-values: allow id: type: string is_active: type: boolean name: type: string raw: additionalProperties: true type: object tax: enum: - PRE_TAX - POST_TAX - TAXABLE - NON_TAXABLE - TAX type: string x-speakeasy-unknown-values: allow type: enum: - RETIREMENT - HEALTH - DENTAL - VISION - LIFE - HSA - FSA - SHORT_TERM_DISABILITY - LONG_TERM_DISABILITY - WORKERS_COMP - HOUSING_STIPEND - EMPLOYER_TAX_CONTRIBUTION - GARNISHMENT - LOAN_REPAYMENT - CHARITABLE_CONTRIBUTION - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object HrisBenefits: items: $ref: '#/components/schemas/HrisBenefit' type: array HrisCompanies: items: $ref: '#/components/schemas/HrisCompany' type: array HrisCompany: properties: address: $ref: '#/components/schemas/property_HrisCompany_address' created_at: format: date-time type: string id: type: string legal_name: type: string name: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object HrisCompensation: properties: amount: type: number currency: type: string frequency: enum: - ONE_TIME - DAY - QUARTER - YEAR - HOUR - MONTH - WEEK type: string x-speakeasy-unknown-values: allow group_id: type: string notes: type: string type: enum: - SALARY - BONUS - STOCK_OPTIONS - EQUITY - OTHER type: string x-speakeasy-unknown-values: allow type: object HrisDeduction: description: Employee-specific deduction/benefit enrolment. properties: amount: type: number benefit_id: type: string company_id: type: string coverage_level: enum: - EMPLOYEE_ONLY - EMPLOYEE_SPOUSE - EMPLOYEE_CHILD - EMPLOYEE_CHILDREN - EMPLOYEE_FAMILY - FAMILY - OTHER type: string x-speakeasy-unknown-values: allow created_at: format: date-time type: string end_at: format: date-time type: string frequency: enum: - ONE_TIME - DAY - QUARTER - YEAR - HOUR - MONTH - WEEK type: string x-speakeasy-unknown-values: allow id: type: string is_active: type: boolean notes: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string type: enum: - FIXED - PERCENTAGE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object HrisDeductions: items: $ref: '#/components/schemas/HrisDeduction' type: array HrisDevice: properties: admin_user_ids: $ref: '#/components/schemas/property_HrisDevice_admin_user_ids' asset_tag: type: string created_at: format: date-time type: string has_antivirus: type: boolean has_firewall: type: boolean has_hd_encrypted: type: boolean has_password_manager: type: boolean has_screenlock: type: boolean id: type: string is_missing: type: boolean location_id: type: string manufacturer: type: string model: type: string name: type: string os: type: string os_version: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_HrisDevice_user_ids' version: type: string required: - name type: object HrisDevices: items: $ref: '#/components/schemas/HrisDevice' type: array HrisEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object HrisEmployee: properties: address: $ref: '#/components/schemas/property_HrisEmployee_address' bio: type: string company_id: type: string compensation: $ref: '#/components/schemas/property_HrisEmployee_compensation' created_at: format: date-time type: string currency: type: string date_of_birth: format: date-time type: string emails: $ref: '#/components/schemas/property_HrisEmployee_emails' employee_number: type: string employee_roles: $ref: '#/components/schemas/property_HrisEmployee_employee_roles' employment_status: enum: - ACTIVE - INACTIVE type: string x-speakeasy-unknown-values: allow employment_type: enum: - FULL_TIME - PART_TIME - CONTRACTOR - INTERN - CONSULTANT - VOLUNTEER - CASUAL - SEASONAL - FREELANCE - OTHER type: string x-speakeasy-unknown-values: allow first_name: type: string gender: enum: - MALE - FEMALE - INTERSEX - TRANS - NON_BINARY type: string x-speakeasy-unknown-values: allow groups: $ref: '#/components/schemas/property_HrisEmployee_groups' has_mfa: type: boolean hired_at: format: date-time type: string id: type: string image_url: type: string language_locale: type: string last_name: type: string locations: $ref: '#/components/schemas/property_HrisEmployee_locations' manager_id: type: string marital_status: enum: - MARRIED - SINGLE type: string x-speakeasy-unknown-values: allow metadata: $ref: '#/components/schemas/property_HrisEmployee_metadata' name: type: string pronouns: type: string raw: additionalProperties: true type: object relationships: $ref: '#/components/schemas/property_HrisEmployee_relationships' salutation: type: string ssn_sin: type: string storage_quota_allocated: type: number storage_quota_available: type: number storage_quota_used: type: number telephones: $ref: '#/components/schemas/property_HrisEmployee_telephones' terminated_at: format: date-time type: string termination_reason: type: string timeoff_days_total: type: number timeoff_days_used: type: number timezone: type: string title: type: string updated_at: format: date-time type: string type: object HrisEmployeerelationship: properties: address: $ref: '#/components/schemas/property_HrisEmployeerelationship_address' emails: $ref: '#/components/schemas/property_HrisEmployeerelationship_emails' end_at: format: date-time type: string first_name: type: string is_beneficiary: type: boolean is_dependent: type: boolean last_name: type: string name: type: string start_at: format: date-time type: string telephones: $ref: '#/components/schemas/property_HrisEmployeerelationship_telephones' type: enum: - EMERGENCY - SPOUSE - CHILD - PARENT - SIBLING - FRIEND - OTHER type: string x-speakeasy-unknown-values: allow type: object HrisEmployees: items: $ref: '#/components/schemas/HrisEmployee' type: array HrisGroup: properties: company_id: type: string created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean manager_ids: $ref: '#/components/schemas/property_HrisGroup_manager_ids' name: type: string parent_id: type: string raw: additionalProperties: true type: object type: enum: - TEAM - GROUP - DEPARTMENT - DIVISION - BUSINESS_UNIT - BRANCH - SUB_DEPARTMENT type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_HrisGroup_user_ids' type: object HrisGroups: items: $ref: '#/components/schemas/HrisGroup' type: array HrisLocation: properties: address: $ref: '#/components/schemas/property_HrisLocation_address' company_id: type: string created_at: format: date-time type: string currency: type: string description: type: string external_identifier: type: string id: type: string is_active: type: boolean is_hq: type: boolean language_locale: type: string name: type: string parent_id: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_HrisLocation_telephones' timezone: type: string updated_at: format: date-time type: string type: object HrisLocations: items: $ref: '#/components/schemas/HrisLocation' type: array HrisMetadata: properties: extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string namespace: type: string slug: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object HrisPayslip: properties: company_id: type: string created_at: format: date-time type: string currency: type: string deduction: $ref: '#/components/schemas/property_HrisPayslip_deduction' details: $ref: '#/components/schemas/property_HrisPayslip_details' end_at: format: date-time type: string gross_amount: type: number id: type: string net_amount: type: number paid_at: format: date-time type: string payment_type: enum: - DIRECT - CHEQUE - CASH type: string x-speakeasy-unknown-values: allow raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string user_id: type: string required: - raw type: object HrisPayslipDetail: properties: amount: type: number company_amount: type: number description: type: string employee_amount: type: number name: type: string type: enum: - EARNING_SALARY - EARNING_OVERTIME - EARNING_TIP - EARNING_BONUS - EARNING_COMMISSION - EARNING_ADJUSTMENT - EARNING - PRETAX_DEDUCTION - PRETAX_DEDUCTION_HEALTH_INSURANCE - PRETAX_DEDUCTION_RETIREMENT - PRETAX_DEDUCTION_HRA - TAX_FEDERAL - TAX_REGION - TAX_LOCAL - POSTTAX_BENEFIT - POSTTAX_GARNISHMENT - REIMBURSEMENT type: string x-speakeasy-unknown-values: allow required: - amount type: object HrisPayslips: items: $ref: '#/components/schemas/HrisPayslip' type: array HrisTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object HrisTimeoff: properties: approved_at: format: date-time type: string approver_user_id: type: string comments: type: string company_id: type: string created_at: format: date-time type: string end_at: format: date-time type: string id: type: string is_paid: type: boolean raw: additionalProperties: true type: object reason: type: string start_at: format: date-time type: string status: enum: - APPROVED - PENDING - DENIED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string required: - start_at type: object HrisTimeoffs: items: $ref: '#/components/schemas/HrisTimeoff' type: array HrisTimeshift: properties: approved_at: format: date-time type: string approver_user_id: type: string company_id: type: string compensation: $ref: '#/components/schemas/property_HrisTimeshift_compensation' created_at: format: date-time type: string employee_user_id: type: string end_at: format: date-time type: string group_id: type: string hours: type: number id: type: string is_approved: type: boolean location_id: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string required: - employee_user_id - start_at - end_at type: object HrisTimeshifts: items: $ref: '#/components/schemas/HrisTimeshift' type: array Integration: description: Informational object for supported integrations. properties: active_healthy_connections: type: number api: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array api_docs_url: type: string beta: type: boolean categories: $ref: '#/components/schemas/property_Integration_categories' color: type: string created_at: type: string description: type: string fa_icon: type: string featured: type: boolean in_progress: type: boolean is_active: type: boolean is_hidden: type: boolean logo_url: type: string name: type: string partnership: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array popularity: type: number rate_limit_description: type: string saml: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array sandbox: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array support: $ref: '#/components/schemas/property_Integration_support' tested_at: format: date-time type: string text_color: type: string token_instructions: $ref: '#/components/schemas/property_Integration_token_instructions' token_names: $ref: '#/components/schemas/property_Integration_token_names' type: type: string updated_at: type: string web_url: type: string required: - type - name - categories type: object IntegrationSupport: properties: from_webhook: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow inbound_fields: $ref: '#/components/schemas/property_IntegrationSupport_inbound_fields' list_account_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_ad_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_application_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_benefit_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_bill_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_branch_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_calendar_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_call_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_campaign_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_candidate_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_carrier_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_category_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_channel_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_class_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_collection_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_company_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_contact_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_content_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_course_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_customer_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_deal_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_document_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_end_lt: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_event_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_expand: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_form_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_fulltext: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_group_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_instructor_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_interview_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_invoice_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_io_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_item_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_item_variant_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_job_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_label_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_lead_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_limit: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_link_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_list_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_location_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_member_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_offset: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_order: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_order_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_org_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_package_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_page_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_parent_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_payment_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_payslip_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_pipeline_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_project_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_query: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_raw_fields: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_reference: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_repo_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_root_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_saleschannel_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_shipment_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_size: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_sort_by_created_at: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_sort_by_name: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_sort_by_updated_at: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_space_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_start_gte: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_status: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_student_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_task_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_teacher_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_template_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_ticket_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_type: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_updated_gte: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_user_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow list_user_mentioned_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow methods: $ref: '#/components/schemas/property_IntegrationSupport_methods' native_webhook_calendar_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_carrier_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_channel_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_company_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_course_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_event_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_form_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_io_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_label_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_list_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_member_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_order_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_parent_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_project_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_shipment_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_student_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_task_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_template_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow native_webhook_type: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow outbound_fields: $ref: '#/components/schemas/property_IntegrationSupport_outbound_fields' raw_objects: $ref: '#/components/schemas/property_IntegrationSupport_raw_objects' search_domain: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow search_email: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow search_linkedinurl: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow search_name: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow search_twitter: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow slow_fields: $ref: '#/components/schemas/property_IntegrationSupport_slow_fields' virtual_webhook_ad_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_application_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_benefit_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_bill_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_branch_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_calendar_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_call_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_campaign_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_candidate_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_carrier_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_channel_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_collection_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_company_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_contact_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_course_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_customer_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_deal_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_end_lt: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_event_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_expand: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_fields: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_form_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_group_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_invoice_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_io_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_item_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_item_variant_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_job_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_label_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_lead_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_limit: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_link_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_list_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_location_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_member_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_order_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_org_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_page_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_parent_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_payment_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_pipeline_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_project_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_reference: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_repo_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_saleschannel_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_shipment_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_space_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_start_gte: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_status: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_student_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_task_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_template_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_ticket_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_type: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_updated_gte: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_user_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow virtual_webhook_user_mentioned_id: enum: - supported-required - supported - not-supported type: string x-speakeasy-unknown-values: allow webhook_events: $ref: '#/components/schemas/property_IntegrationSupport_webhook_events' type: object Integrations: items: $ref: '#/components/schemas/Integration' type: array Issue: properties: created_at: type: string id: type: string importance: type: number resolution_time: type: number size: type: number status: enum: - COMPLETED - NEW - ROADMAP - IN_PROGRESS - ON_HOLD - VALIDATING - REJECTED type: string x-speakeasy-unknown-values: allow ticket_ref: type: string title: type: string type: $ref: '#/components/schemas/property_Issue_type' updated_at: type: string url: type: string workspace_id: type: string required: - title - status - workspace_id - ticket_ref type: object Issues: items: $ref: '#/components/schemas/Issue' type: array KmsComment: properties: content: type: string content_type: enum: - HTML - MARKDOWN - TEXT - OTHER type: string x-speakeasy-unknown-values: allow created_at: format: date-time type: string id: type: string page_id: type: string parent_id: type: string raw: additionalProperties: true type: object type: enum: - PAGE_INLINE - PAGE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string required: - content type: object KmsComments: items: $ref: '#/components/schemas/KmsComment' type: array KmsPage: properties: created_at: format: date-time type: string download_url: type: string has_children: type: boolean id: type: string is_active: type: boolean metadata: $ref: '#/components/schemas/property_KmsPage_metadata' parent_id: type: string raw: additionalProperties: true type: object space_id: type: string title: type: string type: enum: - HTML - MARKDOWN - TEXT - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string web_url: type: string required: - title - type type: object KmsPageMetadata: properties: extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL - PERCENT - EMAIL - PHONE - REFERENCE - TIME type: string x-speakeasy-unknown-values: allow id: type: string namespace: type: string slug: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object KmsPages: items: $ref: '#/components/schemas/KmsPage' type: array KmsSpace: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string parent_id: type: string parent_page_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string user_id: type: string required: - name type: object KmsSpaces: items: $ref: '#/components/schemas/KmsSpace' type: array LmsActivities: items: $ref: '#/components/schemas/LmsActivity' type: array LmsActivity: properties: assigned_grade: type: string completed_at: format: date-time type: string content_id: type: string course_id: type: string created_at: format: date-time type: string duration_minutes: type: number id: type: string is_completed: type: boolean progress_percentage: type: number raw: additionalProperties: true type: object started_at: format: date-time type: string student_id: type: string updated_at: format: date-time type: string type: object LmsClass: properties: course_id: type: string created_at: format: date-time type: string description: type: string id: type: string instructor_ids: $ref: '#/components/schemas/property_LmsClass_instructor_ids' languages: $ref: '#/components/schemas/property_LmsClass_languages' media: $ref: '#/components/schemas/property_LmsClass_media' name: type: string raw: additionalProperties: true type: object student_ids: $ref: '#/components/schemas/property_LmsClass_student_ids' updated_at: format: date-time type: string required: - name - course_id type: object LmsClasses: items: $ref: '#/components/schemas/LmsClass' type: array LmsCollection: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean media: $ref: '#/components/schemas/property_LmsCollection_media' name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object LmsCollections: items: $ref: '#/components/schemas/LmsCollection' type: array LmsContent: properties: categories: $ref: '#/components/schemas/property_LmsContent_categories' collection_ids: $ref: '#/components/schemas/property_LmsContent_collection_ids' course_ids: $ref: '#/components/schemas/property_LmsContent_course_ids' created_at: format: date-time type: string description: type: string duration_minutes: type: number external_reference: type: string id: type: string instructor_ids: $ref: '#/components/schemas/property_LmsContent_instructor_ids' is_active: type: boolean languages: $ref: '#/components/schemas/property_LmsContent_languages' localizations: $ref: '#/components/schemas/property_LmsContent_localizations' media: $ref: '#/components/schemas/property_LmsContent_media' name: type: string provider_name: type: string raw: additionalProperties: true type: object short_description: type: string skills: $ref: '#/components/schemas/property_LmsContent_skills' sort_order: type: number updated_at: format: date-time type: string type: object LmsContentLocalization: properties: description: type: string language: type: string name: type: string type: object LmsContents: items: $ref: '#/components/schemas/LmsContent' type: array LmsCourse: properties: categories: $ref: '#/components/schemas/property_LmsCourse_categories' content_ids: $ref: '#/components/schemas/property_LmsCourse_content_ids' created_at: format: date-time type: string currency: type: string description: type: string duration_minutes: type: number id: type: string instructor_ids: $ref: '#/components/schemas/property_LmsCourse_instructor_ids' instructors: $ref: '#/components/schemas/property_LmsCourse_instructors' is_active: type: boolean is_private: type: boolean languages: $ref: '#/components/schemas/property_LmsCourse_languages' media: $ref: '#/components/schemas/property_LmsCourse_media' name: type: string price_amount: type: number provider_name: type: string published_at: format: date-time type: string raw: additionalProperties: true type: object skills: $ref: '#/components/schemas/property_LmsCourse_skills' student_ids: $ref: '#/components/schemas/property_LmsCourse_student_ids' students: $ref: '#/components/schemas/property_LmsCourse_students' time_estimate_minutes: type: number updated_at: format: date-time type: string required: - name type: object LmsCourses: items: $ref: '#/components/schemas/LmsCourse' type: array LmsEmail: properties: {} type: object LmsInstructor: properties: created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_LmsInstructor_emails' first_name: type: string id: type: string image_url: type: string last_name: type: string name: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_LmsInstructor_telephones' title: type: string updated_at: format: date-time type: string type: object LmsInstructors: items: $ref: '#/components/schemas/LmsInstructor' type: array LmsMedia: properties: content: type: string description: type: string languages: $ref: '#/components/schemas/property_LmsMedia_languages' name: type: string thumbnail_url: type: string type: enum: - IMAGE - HEADSHOT - VIDEO - WEB - DOCUMENT - TEXT - HTML - OTHER type: string x-speakeasy-unknown-values: allow url: type: string type: object LmsStudent: properties: address: $ref: '#/components/schemas/property_LmsStudent_address' created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_LmsStudent_emails' first_name: type: string id: type: string image_url: type: string last_name: type: string name: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_LmsStudent_telephones' updated_at: format: date-time type: string type: object LmsStudents: items: $ref: '#/components/schemas/LmsStudent' type: array LmsTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object LookalikeAudience: properties: id: type: string name: type: string similarity: type: number source_audience_id: type: string required: - id type: object MarketingCampaign: properties: created_at: format: date-time type: string from_email: type: string from_name: type: string id: type: string list_ids: $ref: '#/components/schemas/property_MarketingCampaign_list_ids' name: type: string preview_text: type: string raw: additionalProperties: true type: object reply_to_email: type: string send_at: format: date-time type: string status: enum: - DRAFT - SCHEDULED - SENDING - SENT - CANCELLED - PAUSED - ARCHIVED - OTHER type: string x-speakeasy-unknown-values: allow subject_line: type: string type: type: string updated_at: format: date-time type: string type: object MarketingCampaigns: items: $ref: '#/components/schemas/MarketingCampaign' type: array MarketingEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object MarketingList: description: Mailing List properties: address: $ref: '#/components/schemas/property_MarketingList_address' created_at: format: date-time type: string description: type: string end_at: format: date-time type: string id: type: string is_active: type: boolean language: type: string name: type: string raw: additionalProperties: true type: object sender_company: type: string sender_email: type: string sender_name: type: string sender_phone: type: string start_at: format: date-time type: string subject: type: string updated_at: format: date-time type: string user_id: type: string type: object MarketingLists: items: $ref: '#/components/schemas/MarketingList' type: array MarketingMember: description: A member represents a person properties: created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_MarketingMember_emails' first_name: type: string id: type: string last_name: type: string list_ids: $ref: '#/components/schemas/property_MarketingMember_list_ids' name: type: string raw: additionalProperties: true type: object status: enum: - SUBSCRIBED - UNSUBSCRIBED - CLEANED - PENDING - TRANSACTIONAL type: string x-speakeasy-unknown-values: allow tags: $ref: '#/components/schemas/property_MarketingMember_tags' updated_at: format: date-time type: string type: object MarketingMembers: items: $ref: '#/components/schemas/MarketingMember' type: array MarketingReport: properties: abuse_reports: type: number campaign_id: type: string click_rate: type: number clicks_total: type: number emails_sent: type: number end_at: format: date-time type: string forwards_count: type: number forwards_opens: type: number hard_bounces: type: number id: type: string last_click_at: format: date-time type: string last_open_at: format: date-time type: string links: $ref: '#/components/schemas/property_MarketingReport_links' list_id: type: string open_rate: type: number opens_total: type: number raw: additionalProperties: true type: object sent_at: format: date-time type: string soft_bounces: type: number start_at: format: date-time type: string syntax_errors: type: number unique_clicks: type: number unique_opens: type: number unique_subscriber_clicks: type: number unsubscribed: type: number type: object MarketingReportLink: properties: click_percentage: type: number last_click_at: format: date-time type: string total_clicks: type: number unique_click_percentage: type: number unique_clicks: type: number url: type: string type: object MarketingReports: items: $ref: '#/components/schemas/MarketingReport' type: array MessagingAttachment: properties: content_identifier: type: string content_type: type: string download_url: type: string filename: type: string message_id: type: string size: type: number type: object MessagingButton: properties: icon: type: string id: type: string text: type: string required: - id type: object MessagingChannel: properties: created_at: format: date-time type: string description: type: string has_subchannels: type: boolean id: type: string is_active: type: boolean is_private: type: boolean members: $ref: '#/components/schemas/property_MessagingChannel_members' name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string web_url: type: string required: - name type: object MessagingChannels: items: $ref: '#/components/schemas/MessagingChannel' type: array MessagingEvent: properties: button: $ref: '#/components/schemas/property_MessagingEvent_button' channel: $ref: '#/components/schemas/property_MessagingEvent_channel' created_at: format: date-time type: string id: type: string is_replacing_original: type: boolean message: $ref: '#/components/schemas/property_MessagingEvent_message' raw: additionalProperties: true type: object type: enum: - MESSAGE_RECEIVED - REACTION_ADDED - REACTION_REMOVED - BUTTON_CLICK - APP_MENTION - CHANNEL_JOINED - CHANNEL_LEFT - CHANNEL_CREATED - CHANNEL_DELETED - CHANNEL_RENAMED - USER_CREATED - USER_DELETED - USER_UPDATED type: string x-speakeasy-unknown-values: allow user: $ref: '#/components/schemas/property_MessagingEvent_user' type: object MessagingMember: properties: email: type: string image_url: type: string name: type: string user_id: type: string type: object MessagingMessage: properties: attachments: $ref: '#/components/schemas/property_MessagingMessage_attachments' author_member: $ref: '#/components/schemas/property_MessagingMessage_author_member' buttons: $ref: '#/components/schemas/property_MessagingMessage_buttons' channel_id: type: string channel_ids: $ref: '#/components/schemas/property_MessagingMessage_channel_ids' channels: $ref: '#/components/schemas/property_MessagingMessage_channels' created_at: format: date-time type: string destination_members: $ref: '#/components/schemas/property_MessagingMessage_destination_members' has_children: type: boolean hidden_members: $ref: '#/components/schemas/property_MessagingMessage_hidden_members' id: type: string is_unread: type: boolean mentioned_members: $ref: '#/components/schemas/property_MessagingMessage_mentioned_members' message: type: string message_html: type: string message_markdown: type: string message_thread_identifier: type: string parent_id: type: string raw: additionalProperties: true type: object reactions: $ref: '#/components/schemas/property_MessagingMessage_reactions' reference: type: string root_message_id: type: string subject: type: string updated_at: format: date-time type: string web_url: type: string type: object MessagingMessages: items: $ref: '#/components/schemas/MessagingMessage' type: array MessagingReaction: properties: member: $ref: '#/components/schemas/property_MessagingReaction_member' reaction: type: string required: - reaction - member type: object MessagingReference: properties: id: type: string name: type: string type: object MetadataMetadata: properties: created_at: format: date-time type: string format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string is_required: type: boolean name: type: string object_type: type: string objects: $ref: '#/components/schemas/property_MetadataMetadata_objects' options: $ref: '#/components/schemas/property_MetadataMetadata_options' original_format: type: string raw: additionalProperties: true type: object slug: type: string updated_at: format: date-time type: string required: - name - object_type type: object MetadataMetadatas: items: $ref: '#/components/schemas/MetadataMetadata' type: array PaymentLineitem: properties: account_id: type: string created_at: format: date-time type: string discount_amount: type: number id: type: string item_description: type: string item_id: type: string item_name: type: string item_sku: type: string notes: type: string refund_amount: type: number refunded_at: format: date-time type: string tax_amount: type: number taxrate_id: type: string total_amount: type: number unit_amount: type: number unit_quantity: type: number updated_at: format: date-time type: string type: object PaymentLink: properties: amount: type: number contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string is_active: type: boolean is_chargeable_now: type: boolean lineitems: $ref: '#/components/schemas/property_PaymentLink_lineitems' payment_id: type: string raw: additionalProperties: true type: object success_url: type: string updated_at: format: date-time type: string url: type: string type: object PaymentLinks: items: $ref: '#/components/schemas/PaymentLink' type: array PaymentPayment: properties: account_id: type: string bill_id: type: string contact_id: type: string created_at: format: date-time type: string currency: default: USD type: string id: type: string invoice_id: type: string notes: type: string payment_method: type: string raw: additionalProperties: true type: object reference: type: string total_amount: type: number type: enum: - INVOICE - BILL type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object PaymentPayments: items: $ref: '#/components/schemas/PaymentPayment' type: array PaymentPayout: properties: created_at: type: string currency: type: string id: type: string notes: type: string raw: additionalProperties: true type: object status: enum: - SUCCEEDED - PENDING - FAILED - CANCELED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: type: string required: - total_amount type: object PaymentPayouts: items: $ref: '#/components/schemas/PaymentPayout' type: array PaymentRefund: properties: created_at: format: date-time type: string currency: type: string id: type: string notes: type: string payment_id: type: string raw: additionalProperties: true type: object reference: type: string status: enum: - SUCCEEDED - PENDING - FAILED - CANCELED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: format: date-time type: string required: - total_amount - payment_id type: object PaymentRefunds: items: $ref: '#/components/schemas/PaymentRefund' type: array PaymentSubscription: properties: canceled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string currency: type: string current_period_end_at: format: date-time type: string current_period_start_at: format: date-time type: string day_of_month: type: number day_of_week: type: number description: type: string end_at: format: date-time type: string id: type: string interval: type: number interval_unit: enum: - YEAR - MONTH - WEEK - DAY type: string x-speakeasy-unknown-values: allow invoice_id: type: string lineitems: $ref: '#/components/schemas/property_PaymentSubscription_lineitems' month: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - ACTIVE - INACTIVE - CANCELED - PAUSED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object PaymentSubscriptions: items: $ref: '#/components/schemas/PaymentSubscription' type: array RegionTarget: description: states, provinces, regions properties: id: type: string name: type: string required: - id type: object RepoBranch: properties: created_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object repo_id: type: string updated_at: format: date-time type: string required: - name - repo_id type: object RepoBranches: items: $ref: '#/components/schemas/RepoBranch' type: array RepoCommit: properties: branch_id: type: string created_at: format: date-time type: string id: type: string message: type: string raw: additionalProperties: true type: object repo_id: type: string updated_at: format: date-time type: string user_id: type: string required: - repo_id type: object RepoCommits: items: $ref: '#/components/schemas/RepoCommit' type: array RepoOrganization: properties: avatar_url: type: string created_at: format: date-time type: string description: type: string id: type: string name: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_RepoOrganization_user_ids' web_url: type: string type: object RepoOrganizations: items: $ref: '#/components/schemas/RepoOrganization' type: array RepoPullrequest: properties: closed_at: format: date-time type: string commit_ids: $ref: '#/components/schemas/property_RepoPullrequest_commit_ids' created_at: format: date-time type: string id: type: string labels: $ref: '#/components/schemas/property_RepoPullrequest_labels' raw: additionalProperties: true type: object repo_id: type: string status: enum: - PENDING - APPROVED - REJECTED type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_RepoPullrequest_user_ids' type: object RepoPullrequests: items: $ref: '#/components/schemas/RepoPullrequest' type: array RepoRepositories: items: $ref: '#/components/schemas/RepoRepository' type: array RepoRepository: properties: created_at: format: date-time type: string description: type: string id: type: string is_private: type: boolean name: type: string org_id: type: string owner: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string web_url: type: string required: - name type: object Result: additionalProperties: true description: integration-specific result type: object ScimAddress: properties: country: type: string formatted: type: string locality: type: string postalCode: type: string region: type: string streetAddress: type: string type: enum: - work - home - other type: string x-speakeasy-unknown-values: allow type: object ScimEmail: properties: display: type: string primary: type: boolean type: enum: - work - home - other type: string x-speakeasy-unknown-values: allow value: type: string required: - type type: object ScimEntitlement: properties: display: type: string primary: type: boolean type: type: string value: type: string required: - value type: object ScimGroup: properties: displayName: type: string externalId: type: string groupType: type: string id: type: string members: $ref: '#/components/schemas/property_ScimGroup_members' meta: $ref: '#/components/schemas/property_ScimGroup_meta' schemas: $ref: '#/components/schemas/property_ScimGroup_schemas' required: - displayName type: object ScimGroupMember: properties: $ref: type: string display: type: string operation: enum: - add - delete type: string x-speakeasy-unknown-values: allow type: enum: - User - Group type: string x-speakeasy-unknown-values: allow value: type: string required: - value type: object ScimGroups: items: $ref: '#/components/schemas/ScimGroup' type: array ScimIms: properties: display: type: string primary: type: boolean type: enum: - aim - qtalk - icq - xmpp - msn - skype - qq - yahoo type: string x-speakeasy-unknown-values: allow value: type: string type: object ScimManager: description: '"id" attribute of another User.' properties: $ref: type: string displayName: type: string managerId: type: string type: enum: - direct - indirect type: string x-speakeasy-unknown-values: allow value: type: string type: object ScimPhoneNumber: properties: display: type: string primary: type: boolean type: enum: - work - home - other - mobile - fax - pager type: string x-speakeasy-unknown-values: allow value: type: string type: object ScimPhoto: properties: display: type: string primary: type: boolean type: enum: - photo - thumbnail type: string x-speakeasy-unknown-values: allow value: type: string type: object ScimRole: properties: display: type: string primary: type: boolean type: type: string value: type: string required: - value type: object ScimUser: properties: active: type: boolean addresses: $ref: '#/components/schemas/property_ScimUser_addresses' displayName: type: string emails: $ref: '#/components/schemas/property_ScimUser_emails' entitlements: $ref: '#/components/schemas/property_ScimUser_entitlements' externalId: type: string groups: $ref: '#/components/schemas/property_ScimUser_groups' id: type: string ims: $ref: '#/components/schemas/property_ScimUser_ims' locale: type: string meta: $ref: '#/components/schemas/property_ScimUser_meta' name: $ref: '#/components/schemas/property_ScimUser_name' nickName: type: string password: type: string phoneNumbers: $ref: '#/components/schemas/property_ScimUser_phoneNumbers' photos: $ref: '#/components/schemas/property_ScimUser_photos' preferredLanguage: type: string profileUrl: type: string roles: $ref: '#/components/schemas/property_ScimUser_roles' schemas: $ref: '#/components/schemas/property_ScimUser_schemas' timezone: type: string title: type: string urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: $ref: '#/components/schemas/property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User' urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User: $ref: '#/components/schemas/property_ScimUser_urn_ietf_params_scim_schemas_extension_lattice_attributes_1_0_User' urn:ietf:params:scim:schemas:extension:peakon:2.0:User: $ref: '#/components/schemas/property_ScimUser_urn_ietf_params_scim_schemas_extension_peakon_2_0_User' userName: type: string userType: type: string x509Certificates: $ref: '#/components/schemas/property_ScimUser_x509Certificates' type: object ScimUserGroups: properties: $ref: type: string display: type: string type: enum: - direct - indirect type: string x-speakeasy-unknown-values: allow value: type: string required: - value type: object ScimUsers: items: $ref: '#/components/schemas/ScimUser' type: array ShippingCarrier: properties: code: type: string created_at: format: date-time type: string id: type: string is_active: type: boolean logo_url: type: string name: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string website_url: type: string type: object ShippingCarriers: items: $ref: '#/components/schemas/ShippingCarrier' type: array ShippingCustomsItem: properties: amount: type: number country_of_origin: type: string currency: type: string description: type: string harmonized_tariff_code: type: string quantity: type: number sku: type: string weight: type: number weight_unit: enum: - g - kg - oz - lb type: string x-speakeasy-unknown-values: allow type: object ShippingLabel: properties: created_at: format: date-time type: string id: type: string is_voided: type: boolean label_cost: type: number label_cost_currency: type: string label_format: enum: - PDF - PNG - ZPL - EPL2 - PDF_4X6 - PDF_4X8 - PNG_4X6 - PNG_4X8 type: string x-speakeasy-unknown-values: allow label_url: type: string rate_id: type: string raw: additionalProperties: true type: object service_code: type: string shipment_id: type: string status: enum: - PENDING - PROCESSING - IN_TRANSIT - DELIVERED - EXCEPTION - CANCELLED - LABEL_CREATED - PICKED_UP - OUT_FOR_DELIVERY - DELIVERY_ATTEMPTED - RETURNED_TO_SENDER - HELD_AT_LOCATION - CUSTOMS_CLEARANCE - EXCEPTION_RESOLVED type: string x-speakeasy-unknown-values: allow tracking_number: type: string updated_at: format: date-time type: string type: object ShippingLabels: items: $ref: '#/components/schemas/ShippingLabel' type: array ShippingPackage: properties: currency: type: string description: type: string height: type: number insured_amount: type: number length: type: number size_unit: enum: - cm - inch type: string x-speakeasy-unknown-values: allow tracking_number: type: string value: type: number weight: type: number weight_unit: enum: - g - kg - oz - lb type: string x-speakeasy-unknown-values: allow width: type: number type: object ShippingRate: properties: carrier_id: type: string currency: type: string from_address: $ref: '#/components/schemas/property_ShippingRate_from_address' id: type: string packages: $ref: '#/components/schemas/property_ShippingRate_packages' rates: $ref: '#/components/schemas/property_ShippingRate_rates' raw: additionalProperties: true type: object ship_by_at: format: date-time type: string shipment_id: type: string to_address: $ref: '#/components/schemas/property_ShippingRate_to_address' type: object ShippingRateRate: properties: amount: type: number base_amount: type: number currency: type: string delivery_days: type: number delivery_terms: type: string description: type: string discount_amount: type: number estimated_days: type: number estimated_delivery_end_at: format: date-time type: string estimated_delivery_start_at: format: date-time type: string is_active: type: boolean is_guaranteed: type: boolean is_negotiated_rate: type: boolean is_trackable: type: boolean package_type: type: string rate_source: type: string surcharges: $ref: '#/components/schemas/property_ShippingRateRate_surcharges' tax_amount: type: number title: type: string transit_hours: type: number required: - title type: object ShippingRateSurcharge: properties: amount: type: number code: type: string description: type: string name: type: string type: object ShippingShipment: properties: carrier_id: type: string created_at: format: date-time type: string customs: $ref: '#/components/schemas/property_ShippingShipment_customs' from_address: $ref: '#/components/schemas/property_ShippingShipment_from_address' id: type: string insurance: $ref: '#/components/schemas/property_ShippingShipment_insurance' is_adult_signature_required: type: boolean is_international: type: boolean is_rate_guaranteed: type: boolean is_return: type: boolean is_signature_required: type: boolean label_id: type: string order_id: type: string original_shipment_id: type: string packages: $ref: '#/components/schemas/property_ShippingShipment_packages' rate_amount: type: number rate_currency: type: string rate_estimated_days: type: number rate_estimated_delivery_at: format: date-time type: string rate_id: type: string rate_service_name: type: string raw: additionalProperties: true type: object reference_number: type: string return_address: $ref: '#/components/schemas/property_ShippingShipment_return_address' return_authorization_number: type: string return_reason: type: string return_type: enum: - CUSTOMER - VENDOR - WARRANTY - DEFECTIVE - OTHER type: string x-speakeasy-unknown-values: allow service_code: type: string shipped_at: format: date-time type: string special_instructions: $ref: '#/components/schemas/property_ShippingShipment_special_instructions' status: enum: - PENDING - PROCESSING - IN_TRANSIT - DELIVERED - EXCEPTION - CANCELLED - LABEL_CREATED - PICKED_UP - OUT_FOR_DELIVERY - DELIVERY_ATTEMPTED - RETURNED_TO_SENDER - HELD_AT_LOCATION - CUSTOMS_CLEARANCE - EXCEPTION_RESOLVED type: string x-speakeasy-unknown-values: allow to_address: $ref: '#/components/schemas/property_ShippingShipment_to_address' tracking_id: type: string updated_at: format: date-time type: string warehouse_location_id: type: string warehouse_location_name: type: string type: object ShippingShipments: items: $ref: '#/components/schemas/ShippingShipment' type: array ShippingTracking: properties: actual_delivery_at: format: date-time type: string carrier_id: type: string carrier_status_code: type: string carrier_status_description: type: string created_at: format: date-time type: string estimated_delivery: format: date-time type: string events: $ref: '#/components/schemas/property_ShippingTracking_events' id: type: string raw: additionalProperties: true type: object shipment_id: type: string status: enum: - PENDING - PROCESSING - IN_TRANSIT - DELIVERED - EXCEPTION - CANCELLED - LABEL_CREATED - PICKED_UP - OUT_FOR_DELIVERY - DELIVERY_ATTEMPTED - RETURNED_TO_SENDER - HELD_AT_LOCATION - CUSTOMS_CLEARANCE - EXCEPTION_RESOLVED type: string x-speakeasy-unknown-values: allow status_description: type: string tracking_number: type: string updated_at: format: date-time type: string type: object ShippingTrackingEvent: properties: carrier_status_code: type: string created_at: format: date-time type: string description: type: string event_code: type: string location_address: $ref: '#/components/schemas/property_ShippingTrackingEvent_location_address' location_id: type: string location_name: type: string notes: type: string signed_by: type: string status: enum: - PENDING - PROCESSING - IN_TRANSIT - DELIVERED - EXCEPTION - CANCELLED - LABEL_CREATED - PICKED_UP - OUT_FOR_DELIVERY - DELIVERY_ATTEMPTED - RETURNED_TO_SENDER - HELD_AT_LOCATION - CUSTOMS_CLEARANCE - EXCEPTION_RESOLVED type: string x-speakeasy-unknown-values: allow type: object SigningDocument: properties: completed_at: format: date-time type: string created_at: format: date-time type: string creator_id: type: string description: type: string download_url: type: string expires_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object sent_at: format: date-time type: string status: enum: - DRAFT - SENT - DELIVERED - IN_PROGRESS - COMPLETED - DECLINED - VOIDED - EXPIRED type: string x-speakeasy-unknown-values: allow template_id: type: string updated_at: format: date-time type: string type: object SigningDocuments: items: $ref: '#/components/schemas/SigningDocument' type: array SigningSignatories: items: $ref: '#/components/schemas/SigningSignatory' type: array SigningSignatory: properties: created_at: format: date-time type: string decline_reason: type: string document_id: type: string email: type: string id: type: string name: type: string order: type: number raw: additionalProperties: true type: object role: enum: - SIGNER - CC - APPROVER - IN_PERSON_SIGNER - VIEWER type: string x-speakeasy-unknown-values: allow signed_at: format: date-time type: string status: enum: - PENDING - SENT - DELIVERED - SIGNED - DECLINED - ERROR type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object SigningTemplate: properties: created_at: format: date-time type: string creator_id: type: string description: type: string id: type: string is_active: type: boolean name: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object SigningTemplates: items: $ref: '#/components/schemas/SigningTemplate' type: array StorageFile: properties: created_at: format: date-time type: string data: type: string description: type: string download_url: type: string hash: type: string id: type: string mime_type: type: string name: type: string parent_id: type: string permissions: $ref: '#/components/schemas/property_StorageFile_permissions' raw: additionalProperties: true type: object references: $ref: '#/components/schemas/property_StorageFile_references' size: type: number type: enum: - FILE - FOLDER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string version: type: string web_url: type: string type: object StorageFiles: items: $ref: '#/components/schemas/StorageFile' type: array StoragePermission: properties: group_id: type: string is_hidden: type: boolean is_public: type: boolean roles: $ref: '#/components/schemas/property_StoragePermission_roles' user_id: type: string required: - roles type: object StorageReference: properties: id: type: string name: type: string type: type: string type: object TaskChange: properties: created_at: format: date-time type: string id: type: string items: $ref: '#/components/schemas/property_TaskChange_items' raw: additionalProperties: true type: object task_id: type: string updated_at: format: date-time type: string user_id: type: string type: object TaskChangeItem: properties: field: type: string from: type: string to: type: string required: - field type: object TaskChanges: items: $ref: '#/components/schemas/TaskChange' type: array TaskComment: properties: created_at: format: date-time type: string id: type: string raw: additionalProperties: true type: object task_id: type: string text: type: string updated_at: format: date-time type: string user_id: type: string user_name: type: string required: - text type: object TaskComments: items: $ref: '#/components/schemas/TaskComment' type: array TaskMetadata: properties: extra_data: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array format: enum: - TEXT - NUMBER - DATE - BOOLEAN - FILE - TEXTAREA - SINGLE_SELECT - MULTIPLE_SELECT - MEASUREMENT - PRICE - YES_NO - CURRENCY - URL type: string x-speakeasy-unknown-values: allow id: type: string key: type: string namespace: type: string slug: type: string type: type: string value: additionalProperties: true anyOf: - type: object - type: string - type: number - type: boolean - items: anyOf: - type: object - type: string - type: number - type: boolean type: array type: object TaskProject: properties: created_at: format: date-time type: string description: type: string group_ids: $ref: '#/components/schemas/property_TaskProject_group_ids' has_children: type: boolean has_tasks: type: boolean id: type: string metadata: $ref: '#/components/schemas/property_TaskProject_metadata' name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string user_ids: $ref: '#/components/schemas/property_TaskProject_user_ids' type: object TaskProjects: items: $ref: '#/components/schemas/TaskProject' type: array TaskTask: properties: assigned_user_ids: $ref: '#/components/schemas/property_TaskTask_assigned_user_ids' attachment_ids: $ref: '#/components/schemas/property_TaskTask_attachment_ids' completed_at: format: date-time type: string created_at: format: date-time type: string creator_user_id: type: string due_at: format: date-time type: string follower_user_ids: $ref: '#/components/schemas/property_TaskTask_follower_user_ids' group_ids: $ref: '#/components/schemas/property_TaskTask_group_ids' has_children: type: boolean id: type: string metadata: $ref: '#/components/schemas/property_TaskTask_metadata' name: type: string notes: type: string parent_id: type: string priority: type: string project_id: type: string raw: additionalProperties: true type: object status: enum: - OPENED - IN_PROGRESS - COMPLETED type: string x-speakeasy-unknown-values: allow tags: $ref: '#/components/schemas/property_TaskTask_tags' updated_at: format: date-time type: string url: type: string type: object TaskTasks: items: $ref: '#/components/schemas/TaskTask' type: array TicketingCategories: items: $ref: '#/components/schemas/TicketingCategory' type: array TicketingCategory: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object TicketingCustomer: properties: created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_TicketingCustomer_emails' id: type: string name: type: string raw: additionalProperties: true type: object tags: $ref: '#/components/schemas/property_TicketingCustomer_tags' telephones: $ref: '#/components/schemas/property_TicketingCustomer_telephones' updated_at: format: date-time type: string type: object TicketingCustomers: items: $ref: '#/components/schemas/TicketingCustomer' type: array TicketingEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object TicketingNote: properties: created_at: format: date-time type: string customer_id: type: string description: type: string id: type: string raw: additionalProperties: true type: object ticket_id: type: string updated_at: format: date-time type: string user_id: type: string type: object TicketingNotes: items: $ref: '#/components/schemas/TicketingNote' type: array TicketingTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object TicketingTicket: properties: category: type: string category_id: type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: type: string description: type: string id: type: string priority: type: string raw: additionalProperties: true type: object source: type: string source_ref: type: string status: enum: - ACTIVE - CLOSED type: string x-speakeasy-unknown-values: allow subject: type: string tags: $ref: '#/components/schemas/property_TicketingTicket_tags' updated_at: format: date-time type: string url: type: string user_id: type: string type: object TicketingTickets: items: $ref: '#/components/schemas/TicketingTicket' type: array UcCall: properties: contact_id: type: string contacts: $ref: '#/components/schemas/property_UcCall_contacts' created_at: format: date-time type: string end_at: format: date-time type: string id: type: string is_private: type: boolean raw: additionalProperties: true type: object start_at: format: date-time type: string telephone: $ref: '#/components/schemas/property_UcCall_telephone' type: enum: - INBOUND - OUTBOUND type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string user_name: type: string user_phone: type: string type: object UcCalls: items: $ref: '#/components/schemas/UcCall' type: array UcComment: properties: call_id: type: string content: type: string created_at: type: string id: type: string raw: additionalProperties: true type: object updated_at: type: string user_id: type: string required: - content type: object UcComments: items: $ref: '#/components/schemas/UcComment' type: array UcContact: description: A contact represents a person that optionally is associated with a call properties: company: type: string created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_UcContact_emails' first_name: type: string id: type: string last_name: type: string name: type: string raw: additionalProperties: true type: object telephones: $ref: '#/components/schemas/property_UcContact_telephones' title: type: string updated_at: format: date-time type: string type: object UcContacts: items: $ref: '#/components/schemas/UcContact' type: array UcEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object UcRecording: properties: call_id: type: string contact_id: type: string contact_name: type: string contact_phone: type: string created_at: format: date-time type: string end_at: format: date-time type: string expires_at: format: date-time type: string id: type: string media: $ref: '#/components/schemas/property_UcRecording_media' raw: additionalProperties: true type: object start_at: format: date-time type: string type: enum: - INBOUND - OUTBOUND type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string user_name: type: string user_phone: type: string web_url: type: string type: object UcRecordingMedia: properties: end_at: format: date-time type: string language: type: string recording_download_url: type: string start_at: format: date-time type: string transcript_download_url: type: string transcripts: $ref: '#/components/schemas/property_UcRecordingMedia_transcripts' type: object UcRecordingTranscript: properties: contact_id: type: string end_at: format: date-time type: string start_at: format: date-time type: string text: type: string user_id: type: string required: - text type: object UcRecordings: items: $ref: '#/components/schemas/UcRecording' type: array UcTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object VerificationAddress: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object VerificationPackage: properties: aliases: $ref: '#/components/schemas/property_VerificationPackage_aliases' average_processing_times: $ref: '#/components/schemas/property_VerificationPackage_average_processing_times' cost_amount: type: number created_at: format: date-time type: string currency: type: string description: type: string has_redirect_url: type: boolean has_target_url: type: boolean id: type: string info_url: type: string max_score: type: number name: type: string needs_ip_address: type: boolean parameters: $ref: '#/components/schemas/property_VerificationPackage_parameters' raw: additionalProperties: true type: object tags: $ref: '#/components/schemas/property_VerificationPackage_tags' type: enum: - IDENTITY_VERIFICATION - SCREENING - BACKGROUND_CHECK - EMPLOYMENT_VERIFICATION - EDUCATION_VERIFICATION - CREDIT_CHECK - FRAUD_PREVENTION - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string valid_regions: $ref: '#/components/schemas/property_VerificationPackage_valid_regions' required: - id - name - type type: object VerificationPackages: items: $ref: '#/components/schemas/VerificationPackage' type: array VerificationParameter: properties: file_types: $ref: '#/components/schemas/property_VerificationParameter_file_types' id: type: string is_required: type: boolean name: type: string options: $ref: '#/components/schemas/property_VerificationParameter_options' public_question: type: string type: enum: - TEXT - NUMBER - MULTIPLE_CHOICE - MULTIPLE_SELECT - DATE - FILE type: string x-speakeasy-unknown-values: allow valid_regions: $ref: '#/components/schemas/property_VerificationParameter_valid_regions' required: - name type: object VerificationParameterInput: properties: id: type: string inputs: $ref: '#/components/schemas/property_VerificationParameterInput_inputs' name: type: string type: object VerificationRequest: properties: candidate_id: type: string created_at: format: date-time type: string id: type: string package_id: type: string parameters: $ref: '#/components/schemas/property_VerificationRequest_parameters' profile_addresses: $ref: '#/components/schemas/property_VerificationRequest_profile_addresses' profile_date_of_birth: type: string profile_emails: $ref: '#/components/schemas/property_VerificationRequest_profile_emails' profile_gender: enum: - MALE - FEMALE - INTERSEX - TRANS - NON_BINARY type: string x-speakeasy-unknown-values: allow profile_ip_address: type: string profile_name: type: string profile_national_identifier: type: string profile_telephones: $ref: '#/components/schemas/property_VerificationRequest_profile_telephones' raw: additionalProperties: true type: object response_completed_at: format: date-time type: string response_details: $ref: '#/components/schemas/property_VerificationRequest_response_details' response_download_urls: $ref: '#/components/schemas/property_VerificationRequest_response_download_urls' response_expires_at: format: date-time type: string response_issued_at: format: date-time type: string response_redirect_url: type: string response_score: type: number response_source: type: string response_status: enum: - COMPLETED - FAILED - PASSED - PENDING type: string x-speakeasy-unknown-values: allow target_url: type: string updated_at: format: date-time type: string type: object VerificationRequests: items: $ref: '#/components/schemas/VerificationRequest' type: array VerificationResponseDetail: properties: download_url: type: string is_failed_reason: type: boolean is_private: type: boolean parameter_id: type: string text: type: string title: type: string type: object VerificationTime: properties: milliseconds: type: number valid_regions: $ref: '#/components/schemas/property_VerificationTime_valid_regions' type: object Webhook: description: A webhook is used to POST new/updated information to your server. properties: checked_at: format: date-time type: string connection_id: type: string created_at: format: date-time type: string db_name_prefix: type: string db_schema: type: string db_type: enum: - mongodb - mysql - postgres - mssql - mariadb - supabase type: string x-speakeasy-unknown-values: allow db_url: type: string environment: default: Production type: string event: enum: - updated - created - deleted type: string x-speakeasy-unknown-values: allow fields: type: string filters: $ref: '#/components/schemas/property_Webhook_filters' hook_url: type: string id: type: string integration_type: type: string interval: type: number is_beta: type: boolean is_healthy: type: boolean is_paused: type: boolean object_type: enum: - accounting_account - accounting_transaction - accounting_journal - accounting_contact - accounting_invoice - accounting_bill - accounting_creditmemo - accounting_taxrate - accounting_organization - accounting_order - accounting_salesorder - accounting_purchaseorder - accounting_report - accounting_balancesheet - accounting_profitloss - accounting_trialbalance - accounting_category - accounting_expense - accounting_cashflow - payment_payment - payment_link - payment_payout - payment_refund - payment_subscription - commerce_item - commerce_collection - commerce_inventory - commerce_location - commerce_review - commerce_saleschannel - commerce_itemvariant - commerce_reservation - commerce_availability - verification_package - verification_request - assessment_package - assessment_order - ats_activity - ats_application - ats_applicationstatus - ats_candidate - ats_document - ats_interview - ats_job - ats_scorecard - ats_company - crm_company - crm_contact - crm_deal - crm_event - crm_lead - crm_pipeline - hris_employee - hris_group - hris_payslip - hris_timeoff - hris_company - hris_location - hris_device - hris_timeshift - hris_deduction - hris_benefit - hris_bankaccount - martech_list - martech_member - martech_campaign - martech_report - passthrough - ticketing_note - ticketing_ticket - ticketing_customer - ticketing_category - uc_contact - uc_call - uc_comment - uc_recording - enrich_person - enrich_company - storage_file - genai_model - genai_prompt - genai_embedding - messaging_message - messaging_channel - messaging_event - kms_space - kms_page - kms_comment - task_project - task_task - task_comment - task_change - scim_users - scim_groups - lms_course - lms_class - lms_student - lms_instructor - lms_content - lms_collection - lms_activity - repo_organization - repo_repository - repo_branch - repo_commit - repo_pullrequest - metadata_metadata - calendar_calendar - calendar_event - calendar_busy - calendar_link - calendar_recording - calendar_webinar - ads_organization - ads_ad - ads_campaign - ads_report - ads_group - ads_creative - ads_insertionorder - ads_target - ads_promoted - forms_form - forms_submission - shipping_carrier - shipping_rate - shipping_shipment - shipping_label - shipping_tracking - signing_document - signing_signatory - signing_template type: string x-speakeasy-unknown-values: allow page_max_limit: type: number runs: $ref: '#/components/schemas/property_Webhook_runs' updated_at: format: date-time type: string webhook_type: enum: - virtual - native type: string x-speakeasy-unknown-values: allow workspace_id: type: string required: - connection_id - object_type - event type: object Webhooks: items: $ref: '#/components/schemas/Webhook' type: array property_AccountingAccount_taxonomy: items: $ref: '#/components/schemas/AccountingAccountTaxonomy' type: array property_AccountingAssociatedContact_emails: items: $ref: '#/components/schemas/AccountingEmail' type: array property_AccountingBalancesheetItem_sub_items: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingBalancesheet_assets: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingBalancesheet_equity: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingBalancesheet_liabilities: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingBill_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array property_AccountingBill_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingCashflowItem_sub_items: items: $ref: '#/components/schemas/AccountingCashflowItem' type: array property_AccountingCashflowItem_transaction_ids: description: Optional linkage to transactions items: type: string type: array property_AccountingCashflowSection_items: items: $ref: '#/components/schemas/AccountingCashflowItem' type: array property_AccountingCashflow_category_ids: items: type: string type: array property_AccountingCashflow_financing_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array property_AccountingCashflow_investing_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array property_AccountingCashflow_operating_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array property_AccountingContact_associated_contacts: items: $ref: '#/components/schemas/AccountingAssociatedContact' type: array property_AccountingContact_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingContact_emails: items: $ref: '#/components/schemas/AccountingEmail' type: array property_AccountingContact_payment_methods: items: $ref: '#/components/schemas/AccountingContactPaymentMethod' type: array property_AccountingContact_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingContact_telephones: items: $ref: '#/components/schemas/AccountingTelephone' type: array property_AccountingCreditmemo_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array property_AccountingCreditmemo_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingExpense_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingInvoice_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array property_AccountingInvoice_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingJournalLineitem_category_ids: items: type: string type: array property_AccountingJournal_lineitems: description: new field name items: $ref: '#/components/schemas/AccountingJournalLineitem' type: array property_AccountingLineitem_category_ids: items: type: string type: array property_AccountingLineitem_item_variants: items: $ref: '#/components/schemas/AccountingReference' type: array property_AccountingLineitem_locations: items: $ref: '#/components/schemas/AccountingReference' type: array property_AccountingOrder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingOrder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingOrder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingOrganization_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingProfitlossAccount_transaction_ids: items: type: string type: array property_AccountingProfitlossCategory_sub_items: items: $ref: '#/components/schemas/AccountingProfitlossSubcategory' type: array property_AccountingProfitlossSection_accounts: items: $ref: '#/components/schemas/AccountingProfitlossAccount' type: array property_AccountingProfitlossSubcategory_transaction_ids: items: type: string type: array property_AccountingProfitloss_category_ids: items: type: string type: array property_AccountingProfitloss_cost_of_goods_sold: description: '@deprecated – use cost_of_goods_sold_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingProfitloss_cost_of_goods_sold_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingProfitloss_expenses: description: '@deprecated – use expenses_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingProfitloss_expenses_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingProfitloss_income: description: '@deprecated – use income_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingProfitloss_income_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingPurchaseorder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingPurchaseorder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingPurchaseorder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingReport_balance_sheet: properties: assets: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_assets' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string equity: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_equity' id: type: string liabilities: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_liabilities' name: type: string net_assets_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object property_AccountingReport_balance_sheet_assets: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingReport_balance_sheet_equity: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingReport_balance_sheet_liabilities: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingReport_profit_and_loss: properties: category_ids: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_category_ids' cost_of_goods_sold: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_cost_of_goods_sold' cost_of_goods_sold_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_cost_of_goods_sold_sections' cost_of_goods_sold_total_amount: type: number created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string expenses: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_expenses' expenses_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_expenses_sections' expenses_total_amount: type: number gross_profit_amount: type: number id: type: string income: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_income' income_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_income_sections' income_total_amount: type: number name: type: string net_income_amount: type: number net_profit_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object property_AccountingReport_profit_and_loss_category_ids: items: type: string type: array property_AccountingReport_profit_and_loss_cost_of_goods_sold: description: '@deprecated – use cost_of_goods_sold_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingReport_profit_and_loss_cost_of_goods_sold_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingReport_profit_and_loss_expenses: description: '@deprecated – use expenses_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingReport_profit_and_loss_expenses_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingReport_profit_and_loss_income: description: '@deprecated – use income_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingReport_profit_and_loss_income_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingReport_trial_balance: properties: created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string sub_items: $ref: '#/components/schemas/property_AccountingReport_trial_balance_sub_items' total_credit_amount: type: number total_debit_amount: type: number updated_at: format: date-time type: string type: object property_AccountingReport_trial_balance_sub_items: items: $ref: '#/components/schemas/AccountingTrialbalanceSubItem' type: array property_AccountingSalesorder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingSalesorder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingSalesorder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingTransaction_contacts: items: $ref: '#/components/schemas/AccountingTransactionContact' type: array property_AccountingTransaction_lineitems: items: $ref: '#/components/schemas/AccountingTransactionLineItem' type: array property_AccountingTrialbalance_sub_items: items: $ref: '#/components/schemas/AccountingTrialbalanceSubItem' type: array property_AdsAd_creative_ids: items: type: string type: array property_AdsAd_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsCampaign_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsCampaign_targeting: properties: audience: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience' brand_safety: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety' content: $ref: '#/components/schemas/property_AdsCampaign_targeting_content' demographic: $ref: '#/components/schemas/property_AdsCampaign_targeting_demographic' device: $ref: '#/components/schemas/property_AdsCampaign_targeting_device' geographic: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic' language: $ref: '#/components/schemas/property_AdsCampaign_targeting_language' optimization: $ref: '#/components/schemas/property_AdsCampaign_targeting_optimization' placement: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement' schedule: $ref: '#/components/schemas/property_AdsCampaign_targeting_schedule' type: object property_AdsCampaign_targeting_audience: properties: behaviors: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_behaviors' combination_spec: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_combination_spec' custom_audiences: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_custom_audiences' excluded_behaviors: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_excluded_behaviors' excluded_custom_audiences: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_excluded_custom_audiences' excluded_interests: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_excluded_interests' interests: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_interests' lookalike_audiences: $ref: '#/components/schemas/property_AdsCampaign_targeting_audience_lookalike_audiences' type: object property_AdsCampaign_targeting_audience_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_combination_spec: items: $ref: '#/components/schemas/AudienceCombination' type: array property_AdsCampaign_targeting_audience_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_excluded_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_excluded_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_excluded_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsCampaign_targeting_audience_lookalike_audiences: items: $ref: '#/components/schemas/LookalikeAudience' type: array property_AdsCampaign_targeting_brand_safety: description: 'Brand safety (Meta: excluded_publisher_categories, etc.; Google' properties: block_list_ids: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety_block_list_ids' brand_safety_content_filter_levels: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety_brand_safety_content_filter_levels' excluded_content_labels: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety_excluded_content_labels' excluded_publisher_categories: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety_excluded_publisher_categories' publisher_visibility_categories: $ref: '#/components/schemas/property_AdsCampaign_targeting_brand_safety_publisher_visibility_categories' type: object property_AdsCampaign_targeting_brand_safety_block_list_ids: items: type: string type: array property_AdsCampaign_targeting_brand_safety_brand_safety_content_filter_levels: items: type: string type: array property_AdsCampaign_targeting_brand_safety_excluded_content_labels: description: Google Ads ContentLabelType items: type: string type: array property_AdsCampaign_targeting_brand_safety_excluded_publisher_categories: items: type: string type: array property_AdsCampaign_targeting_brand_safety_publisher_visibility_categories: items: enum: - limited - standard - expanded type: string x-speakeasy-unknown-values: allow type: array property_AdsCampaign_targeting_content: properties: excluded_keywords: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_excluded_keywords' excluded_topics: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_excluded_topics' excluded_urls: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_excluded_urls' keywords: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_keywords' topics: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_topics' urls: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_urls' video: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video' type: object property_AdsCampaign_targeting_content_excluded_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsCampaign_targeting_content_excluded_topics: items: type: string type: array property_AdsCampaign_targeting_content_excluded_urls: items: type: string type: array property_AdsCampaign_targeting_content_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsCampaign_targeting_content_topics: items: type: string type: array property_AdsCampaign_targeting_content_urls: items: type: string type: array property_AdsCampaign_targeting_content_video: properties: durations: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_durations' excluded_youtube_channels: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_excluded_youtube_channels' excluded_youtube_videos: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_excluded_youtube_videos' player_sizes: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_player_sizes' positions: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_positions' youtube_channels: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_youtube_channels' youtube_videos: $ref: '#/components/schemas/property_AdsCampaign_targeting_content_video_youtube_videos' type: object property_AdsCampaign_targeting_content_video_durations: items: enum: - SHORT - MEDIUM - LONG type: string x-speakeasy-unknown-values: allow type: array property_AdsCampaign_targeting_content_video_excluded_youtube_channels: items: type: string type: array property_AdsCampaign_targeting_content_video_excluded_youtube_videos: items: type: string type: array property_AdsCampaign_targeting_content_video_player_sizes: items: enum: - SMALL - LARGE - HD type: string x-speakeasy-unknown-values: allow type: array property_AdsCampaign_targeting_content_video_positions: items: enum: - PREROLL - MIDROLL - POSTROLL - INSTREAM - OUTSTREAM type: string x-speakeasy-unknown-values: allow type: array property_AdsCampaign_targeting_content_video_youtube_channels: items: type: string type: array property_AdsCampaign_targeting_content_video_youtube_videos: items: type: string type: array property_AdsCampaign_targeting_demographic: description: 'Demographic targeting (Meta: age_min, age_max, genders)' properties: age_max: type: number age_min: type: number female: type: boolean male: type: boolean type: object property_AdsCampaign_targeting_device: properties: carriers: $ref: '#/components/schemas/property_AdsCampaign_targeting_device_carriers' types: $ref: '#/components/schemas/property_AdsCampaign_targeting_device_types' user_device: $ref: '#/components/schemas/property_AdsCampaign_targeting_device_user_device' user_os: $ref: '#/components/schemas/property_AdsCampaign_targeting_device_user_os' type: object property_AdsCampaign_targeting_device_carriers: items: type: string type: array property_AdsCampaign_targeting_device_types: items: type: string type: array property_AdsCampaign_targeting_device_user_device: items: type: string type: array property_AdsCampaign_targeting_device_user_os: items: type: string type: array property_AdsCampaign_targeting_geographic: properties: cities: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_cities' countries: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_countries' excluded_cities: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_excluded_cities' excluded_countries: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_excluded_countries' excluded_postal_codes: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_excluded_postal_codes' excluded_regions: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_excluded_regions' excluded_us_dmas: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_excluded_us_dmas' location_types: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_location_types' postal_codes: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_postal_codes' presence_type: enum: - PRESENCE - PRESENCE_OR_INTEREST type: string x-speakeasy-unknown-values: allow regions: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_regions' us_dmas: $ref: '#/components/schemas/property_AdsCampaign_targeting_geographic_us_dmas' type: object property_AdsCampaign_targeting_geographic_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsCampaign_targeting_geographic_countries: items: type: string type: array property_AdsCampaign_targeting_geographic_excluded_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsCampaign_targeting_geographic_excluded_countries: items: type: string type: array property_AdsCampaign_targeting_geographic_excluded_postal_codes: items: type: string type: array property_AdsCampaign_targeting_geographic_excluded_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsCampaign_targeting_geographic_excluded_us_dmas: items: type: string type: array property_AdsCampaign_targeting_geographic_location_types: items: enum: - HOME - RECENT - TRAVEL type: string x-speakeasy-unknown-values: allow type: array property_AdsCampaign_targeting_geographic_postal_codes: items: type: string type: array property_AdsCampaign_targeting_geographic_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsCampaign_targeting_geographic_us_dmas: items: type: string type: array property_AdsCampaign_targeting_language: description: Language targeting (Meta properties: codes: $ref: '#/components/schemas/property_AdsCampaign_targeting_language_codes' locale_ids: $ref: '#/components/schemas/property_AdsCampaign_targeting_language_locale_ids' type: object property_AdsCampaign_targeting_language_codes: items: type: string type: array property_AdsCampaign_targeting_language_locale_ids: items: type: number type: array property_AdsCampaign_targeting_optimization: description: 'Optimization (Meta: targeting_automation; Google: observation vs targeting mode)' properties: advantage_audience: type: boolean advantage_placements: type: boolean mode: enum: - TARGETING - OBSERVATION type: string x-speakeasy-unknown-values: allow targeting_optimization_expansion_all: type: boolean type: object property_AdsCampaign_targeting_placement: properties: audience_network_positions: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement_audience_network_positions' facebook_positions: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement_facebook_positions' instagram_positions: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement_instagram_positions' messenger_positions: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement_messenger_positions' platforms: $ref: '#/components/schemas/property_AdsCampaign_targeting_placement_platforms' type: object property_AdsCampaign_targeting_placement_audience_network_positions: items: type: string type: array property_AdsCampaign_targeting_placement_facebook_positions: items: type: string type: array property_AdsCampaign_targeting_placement_instagram_positions: items: type: string type: array property_AdsCampaign_targeting_placement_messenger_positions: items: type: string type: array property_AdsCampaign_targeting_placement_platforms: items: type: string type: array property_AdsCampaign_targeting_schedule: items: $ref: '#/components/schemas/AdSchedule' type: array property_AdsCreative_asset_urls: description: Hosted asset mode (best-effort, provider-specific items: type: string type: array property_AdsCreative_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsGroup_bid_strategy: description: YOUTUBE_AND_PARTNERS properties: custom_bidding_algorithm_id: type: string fixed_bid_amount: type: number max_average_cpm_bid_amount: type: number performance_goal_amount: type: number performance_goal_type: enum: - UNSPECIFIED - CPA - CPC - VIEWABLE_CPM - CUSTOM_ALGO - CIVA - IVO_TEN - AV_VIEWED - REACH type: string x-speakeasy-unknown-values: allow raise_bid_for_deals: type: boolean target_roas: type: number type: enum: - FIXED_BID - MAXIMIZE_SPEND - PERFORMANCE_GOAL - YOUTUBE_AND_PARTNERS type: string x-speakeasy-unknown-values: allow youtube_and_partners_type: enum: - UNSPECIFIED - MANUAL_CPV - MANUAL_CPM - TARGET_CPA - TARGET_CPM - RESERVE_CPM - MAXIMIZE_LIFT - MAXIMIZE_CONVERSIONS - TARGET_CPV - TARGET_ROAS - MAXIMIZE_CONVERSION_VALUE type: string x-speakeasy-unknown-values: allow youtube_and_partners_value: type: string required: - type type: object property_AdsGroup_creative_ids: items: type: string type: array property_AdsGroup_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsGroup_pacing: properties: daily_max_amount: type: number daily_max_impressions: type: number period: enum: - UNSPECIFIED - DAILY - FLIGHT type: string x-speakeasy-unknown-values: allow type: type: string type: object property_AdsGroup_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsGroup_targeting: properties: audience: $ref: '#/components/schemas/property_AdsGroup_targeting_audience' brand_safety: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety' content: $ref: '#/components/schemas/property_AdsGroup_targeting_content' demographic: $ref: '#/components/schemas/property_AdsGroup_targeting_demographic' device: $ref: '#/components/schemas/property_AdsGroup_targeting_device' geographic: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic' language: $ref: '#/components/schemas/property_AdsGroup_targeting_language' optimization: $ref: '#/components/schemas/property_AdsGroup_targeting_optimization' placement: $ref: '#/components/schemas/property_AdsGroup_targeting_placement' schedule: $ref: '#/components/schemas/property_AdsGroup_targeting_schedule' type: object property_AdsGroup_targeting_audience: properties: behaviors: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_behaviors' combination_spec: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_combination_spec' custom_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_custom_audiences' excluded_behaviors: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_behaviors' excluded_custom_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_custom_audiences' excluded_interests: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_excluded_interests' interests: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_interests' lookalike_audiences: $ref: '#/components/schemas/property_AdsGroup_targeting_audience_lookalike_audiences' type: object property_AdsGroup_targeting_audience_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_combination_spec: items: $ref: '#/components/schemas/AudienceCombination' type: array property_AdsGroup_targeting_audience_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_excluded_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_excluded_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_excluded_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsGroup_targeting_audience_lookalike_audiences: items: $ref: '#/components/schemas/LookalikeAudience' type: array property_AdsGroup_targeting_brand_safety: description: 'Brand safety (Meta: excluded_publisher_categories, etc.; Google' properties: block_list_ids: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_block_list_ids' brand_safety_content_filter_levels: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels' excluded_content_labels: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_excluded_content_labels' excluded_publisher_categories: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_excluded_publisher_categories' publisher_visibility_categories: $ref: '#/components/schemas/property_AdsGroup_targeting_brand_safety_publisher_visibility_categories' type: object property_AdsGroup_targeting_brand_safety_block_list_ids: items: type: string type: array property_AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels: items: type: string type: array property_AdsGroup_targeting_brand_safety_excluded_content_labels: description: Google Ads ContentLabelType items: type: string type: array property_AdsGroup_targeting_brand_safety_excluded_publisher_categories: items: type: string type: array property_AdsGroup_targeting_brand_safety_publisher_visibility_categories: items: enum: - limited - standard - expanded type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_content: properties: excluded_keywords: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_keywords' excluded_topics: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_topics' excluded_urls: $ref: '#/components/schemas/property_AdsGroup_targeting_content_excluded_urls' keywords: $ref: '#/components/schemas/property_AdsGroup_targeting_content_keywords' topics: $ref: '#/components/schemas/property_AdsGroup_targeting_content_topics' urls: $ref: '#/components/schemas/property_AdsGroup_targeting_content_urls' video: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video' type: object property_AdsGroup_targeting_content_excluded_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsGroup_targeting_content_excluded_topics: items: type: string type: array property_AdsGroup_targeting_content_excluded_urls: items: type: string type: array property_AdsGroup_targeting_content_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsGroup_targeting_content_topics: items: type: string type: array property_AdsGroup_targeting_content_urls: items: type: string type: array property_AdsGroup_targeting_content_video: properties: durations: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_durations' excluded_youtube_channels: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_excluded_youtube_channels' excluded_youtube_videos: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_excluded_youtube_videos' player_sizes: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_player_sizes' positions: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_positions' youtube_channels: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_youtube_channels' youtube_videos: $ref: '#/components/schemas/property_AdsGroup_targeting_content_video_youtube_videos' type: object property_AdsGroup_targeting_content_video_durations: items: enum: - SHORT - MEDIUM - LONG type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_content_video_excluded_youtube_channels: items: type: string type: array property_AdsGroup_targeting_content_video_excluded_youtube_videos: items: type: string type: array property_AdsGroup_targeting_content_video_player_sizes: items: enum: - SMALL - LARGE - HD type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_content_video_positions: items: enum: - PREROLL - MIDROLL - POSTROLL - INSTREAM - OUTSTREAM type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_content_video_youtube_channels: items: type: string type: array property_AdsGroup_targeting_content_video_youtube_videos: items: type: string type: array property_AdsGroup_targeting_demographic: description: 'Demographic targeting (Meta: age_min, age_max, genders)' properties: age_max: type: number age_min: type: number female: type: boolean male: type: boolean type: object property_AdsGroup_targeting_device: properties: carriers: $ref: '#/components/schemas/property_AdsGroup_targeting_device_carriers' types: $ref: '#/components/schemas/property_AdsGroup_targeting_device_types' user_device: $ref: '#/components/schemas/property_AdsGroup_targeting_device_user_device' user_os: $ref: '#/components/schemas/property_AdsGroup_targeting_device_user_os' type: object property_AdsGroup_targeting_device_carriers: items: type: string type: array property_AdsGroup_targeting_device_types: items: type: string type: array property_AdsGroup_targeting_device_user_device: items: type: string type: array property_AdsGroup_targeting_device_user_os: items: type: string type: array property_AdsGroup_targeting_geographic: properties: cities: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_cities' countries: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_countries' excluded_cities: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_cities' excluded_countries: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_countries' excluded_postal_codes: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_postal_codes' excluded_regions: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_regions' excluded_us_dmas: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_excluded_us_dmas' location_types: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_location_types' postal_codes: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_postal_codes' presence_type: enum: - PRESENCE - PRESENCE_OR_INTEREST type: string x-speakeasy-unknown-values: allow regions: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_regions' us_dmas: $ref: '#/components/schemas/property_AdsGroup_targeting_geographic_us_dmas' type: object property_AdsGroup_targeting_geographic_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsGroup_targeting_geographic_countries: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsGroup_targeting_geographic_excluded_countries: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_postal_codes: items: type: string type: array property_AdsGroup_targeting_geographic_excluded_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsGroup_targeting_geographic_excluded_us_dmas: items: type: string type: array property_AdsGroup_targeting_geographic_location_types: items: enum: - HOME - RECENT - TRAVEL type: string x-speakeasy-unknown-values: allow type: array property_AdsGroup_targeting_geographic_postal_codes: items: type: string type: array property_AdsGroup_targeting_geographic_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsGroup_targeting_geographic_us_dmas: items: type: string type: array property_AdsGroup_targeting_language: description: Language targeting (Meta properties: codes: $ref: '#/components/schemas/property_AdsGroup_targeting_language_codes' locale_ids: $ref: '#/components/schemas/property_AdsGroup_targeting_language_locale_ids' type: object property_AdsGroup_targeting_language_codes: items: type: string type: array property_AdsGroup_targeting_language_locale_ids: items: type: number type: array property_AdsGroup_targeting_optimization: description: 'Optimization (Meta: targeting_automation; Google: observation vs targeting mode)' properties: advantage_audience: type: boolean advantage_placements: type: boolean mode: enum: - TARGETING - OBSERVATION type: string x-speakeasy-unknown-values: allow targeting_optimization_expansion_all: type: boolean type: object property_AdsGroup_targeting_placement: properties: audience_network_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_audience_network_positions' facebook_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_facebook_positions' instagram_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_instagram_positions' messenger_positions: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_messenger_positions' platforms: $ref: '#/components/schemas/property_AdsGroup_targeting_placement_platforms' type: object property_AdsGroup_targeting_placement_audience_network_positions: items: type: string type: array property_AdsGroup_targeting_placement_facebook_positions: items: type: string type: array property_AdsGroup_targeting_placement_instagram_positions: items: type: string type: array property_AdsGroup_targeting_placement_messenger_positions: items: type: string type: array property_AdsGroup_targeting_placement_platforms: items: type: string type: array property_AdsGroup_targeting_schedule: items: $ref: '#/components/schemas/AdSchedule' type: array property_AdsInsertionorder_bid_strategy: description: YOUTUBE_AND_PARTNERS properties: custom_bidding_algorithm_id: type: string fixed_bid_amount: type: number max_average_cpm_bid_amount: type: number performance_goal_amount: type: number performance_goal_type: enum: - UNSPECIFIED - CPA - CPC - VIEWABLE_CPM - CUSTOM_ALGO - CIVA - IVO_TEN - AV_VIEWED - REACH type: string x-speakeasy-unknown-values: allow raise_bid_for_deals: type: boolean target_roas: type: number type: enum: - FIXED_BID - MAXIMIZE_SPEND - PERFORMANCE_GOAL - YOUTUBE_AND_PARTNERS type: string x-speakeasy-unknown-values: allow youtube_and_partners_type: enum: - UNSPECIFIED - MANUAL_CPV - MANUAL_CPM - TARGET_CPA - TARGET_CPM - RESERVE_CPM - MAXIMIZE_LIFT - MAXIMIZE_CONVERSIONS - TARGET_CPV - TARGET_ROAS - MAXIMIZE_CONVERSION_VALUE type: string x-speakeasy-unknown-values: allow youtube_and_partners_value: type: string required: - type type: object property_AdsInsertionorder_budget_segments: items: $ref: '#/components/schemas/AdsInsertionorderBudgetSegment' type: array property_AdsInsertionorder_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsInsertionorder_kpi: properties: algorithm_id: type: string amount: type: number percentage: type: number string_value: type: string type: enum: - UNSPECIFIED - CPM - CPC - CPA - CTR - VIEWABILITY - CPIAVC - CPE - CPV - CLICK_CVR - IMPRESSION_CVR - VCPM - VTR - AUDIO_COMPLETION_RATE - VIDEO_COMPLETION_RATE - CPCL - CPCV - TOS10 - MAXIMIZE_PACING - CUSTOM_IMPRESSION_VALUE_OVER_COST - OTHER type: string x-speakeasy-unknown-values: allow type: object property_AdsInsertionorder_pacing: properties: daily_max_amount: type: number daily_max_impressions: type: number period: enum: - UNSPECIFIED - DAILY - FLIGHT type: string x-speakeasy-unknown-values: allow type: type: string type: object property_AdsReportMetrics_ad: properties: ad_copy: type: string ad_type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string creative_asset_url: type: string creative_ids: $ref: '#/components/schemas/property_AdsReportMetrics_ad_creative_ids' cta: type: string description: type: string display_url: type: string final_url: type: string group_id: type: string headline: type: string id: type: string name: type: string organization_id: type: string path1: type: string path2: type: string promoted: $ref: '#/components/schemas/property_AdsReportMetrics_ad_promoted' raw: additionalProperties: true type: object status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AdsReportMetrics_ad_creative_ids: items: type: string type: array property_AdsReportMetrics_ad_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsReportMetrics_campaign: properties: advertising_channel_type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow budget_amount: type: number budget_period: enum: - DAILY - MONTHLY - TOTAL - LIFETIME type: string x-speakeasy-unknown-values: allow campaign_budget_identifier: type: string category: type: string created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_frequency_cap' goal: enum: - UNSPECIFIED - BRAND_AWARENESS - REACH - WEBSITE_TRAFFIC - LEADS - SALES - APP_PROMOTION type: string x-speakeasy-unknown-values: allow has_eu_political_ads: type: boolean id: type: string name: type: string organization_id: type: string planned_spend_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow targeting: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting' total_spend_amount: type: number updated_at: format: date-time type: string type: object property_AdsReportMetrics_campaign_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsReportMetrics_campaign_targeting: properties: audience: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience' brand_safety: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety' content: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content' demographic: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_demographic' device: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_device' geographic: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic' language: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_language' optimization: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_optimization' placement: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement' schedule: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_schedule' type: object property_AdsReportMetrics_campaign_targeting_audience: properties: behaviors: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_behaviors' combination_spec: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_combination_spec' custom_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_custom_audiences' excluded_behaviors: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_excluded_behaviors' excluded_custom_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_excluded_custom_audiences' excluded_interests: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_excluded_interests' interests: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_interests' lookalike_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_audience_lookalike_audiences' type: object property_AdsReportMetrics_campaign_targeting_audience_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_combination_spec: items: $ref: '#/components/schemas/AudienceCombination' type: array property_AdsReportMetrics_campaign_targeting_audience_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_excluded_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_excluded_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_excluded_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_campaign_targeting_audience_lookalike_audiences: items: $ref: '#/components/schemas/LookalikeAudience' type: array property_AdsReportMetrics_campaign_targeting_brand_safety: description: 'Brand safety (Meta: excluded_publisher_categories, etc.; Google' properties: block_list_ids: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety_block_list_ids' brand_safety_content_filter_levels: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety_brand_safety_content_filter_levels' excluded_content_labels: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety_excluded_content_labels' excluded_publisher_categories: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety_excluded_publisher_categories' publisher_visibility_categories: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_brand_safety_publisher_visibility_categories' type: object property_AdsReportMetrics_campaign_targeting_brand_safety_block_list_ids: items: type: string type: array property_AdsReportMetrics_campaign_targeting_brand_safety_brand_safety_content_filter_levels: items: type: string type: array property_AdsReportMetrics_campaign_targeting_brand_safety_excluded_content_labels: description: Google Ads ContentLabelType items: type: string type: array property_AdsReportMetrics_campaign_targeting_brand_safety_excluded_publisher_categories: items: type: string type: array property_AdsReportMetrics_campaign_targeting_brand_safety_publisher_visibility_categories: items: enum: - limited - standard - expanded type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_campaign_targeting_content: properties: excluded_keywords: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_excluded_keywords' excluded_topics: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_excluded_topics' excluded_urls: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_excluded_urls' keywords: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_keywords' topics: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_topics' urls: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_urls' video: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video' type: object property_AdsReportMetrics_campaign_targeting_content_excluded_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsReportMetrics_campaign_targeting_content_excluded_topics: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_excluded_urls: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsReportMetrics_campaign_targeting_content_topics: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_urls: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_video: properties: durations: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_durations' excluded_youtube_channels: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_channels' excluded_youtube_videos: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_videos' player_sizes: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_player_sizes' positions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_positions' youtube_channels: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_youtube_channels' youtube_videos: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_content_video_youtube_videos' type: object property_AdsReportMetrics_campaign_targeting_content_video_durations: items: enum: - SHORT - MEDIUM - LONG type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_channels: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_videos: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_video_player_sizes: items: enum: - SMALL - LARGE - HD type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_campaign_targeting_content_video_positions: items: enum: - PREROLL - MIDROLL - POSTROLL - INSTREAM - OUTSTREAM type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_campaign_targeting_content_video_youtube_channels: items: type: string type: array property_AdsReportMetrics_campaign_targeting_content_video_youtube_videos: items: type: string type: array property_AdsReportMetrics_campaign_targeting_demographic: description: 'Demographic targeting (Meta: age_min, age_max, genders)' properties: age_max: type: number age_min: type: number female: type: boolean male: type: boolean type: object property_AdsReportMetrics_campaign_targeting_device: properties: carriers: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_device_carriers' types: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_device_types' user_device: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_device_user_device' user_os: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_device_user_os' type: object property_AdsReportMetrics_campaign_targeting_device_carriers: items: type: string type: array property_AdsReportMetrics_campaign_targeting_device_types: items: type: string type: array property_AdsReportMetrics_campaign_targeting_device_user_device: items: type: string type: array property_AdsReportMetrics_campaign_targeting_device_user_os: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic: properties: cities: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_cities' countries: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_countries' excluded_cities: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_excluded_cities' excluded_countries: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_excluded_countries' excluded_postal_codes: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_excluded_postal_codes' excluded_regions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_excluded_regions' excluded_us_dmas: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_excluded_us_dmas' location_types: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_location_types' postal_codes: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_postal_codes' presence_type: enum: - PRESENCE - PRESENCE_OR_INTEREST type: string x-speakeasy-unknown-values: allow regions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_regions' us_dmas: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_geographic_us_dmas' type: object property_AdsReportMetrics_campaign_targeting_geographic_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsReportMetrics_campaign_targeting_geographic_countries: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic_excluded_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsReportMetrics_campaign_targeting_geographic_excluded_countries: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic_excluded_postal_codes: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic_excluded_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsReportMetrics_campaign_targeting_geographic_excluded_us_dmas: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic_location_types: items: enum: - HOME - RECENT - TRAVEL type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_campaign_targeting_geographic_postal_codes: items: type: string type: array property_AdsReportMetrics_campaign_targeting_geographic_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsReportMetrics_campaign_targeting_geographic_us_dmas: items: type: string type: array property_AdsReportMetrics_campaign_targeting_language: description: Language targeting (Meta properties: codes: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_language_codes' locale_ids: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_language_locale_ids' type: object property_AdsReportMetrics_campaign_targeting_language_codes: items: type: string type: array property_AdsReportMetrics_campaign_targeting_language_locale_ids: items: type: number type: array property_AdsReportMetrics_campaign_targeting_optimization: description: 'Optimization (Meta: targeting_automation; Google: observation vs targeting mode)' properties: advantage_audience: type: boolean advantage_placements: type: boolean mode: enum: - TARGETING - OBSERVATION type: string x-speakeasy-unknown-values: allow targeting_optimization_expansion_all: type: boolean type: object property_AdsReportMetrics_campaign_targeting_placement: properties: audience_network_positions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement_audience_network_positions' facebook_positions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement_facebook_positions' instagram_positions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement_instagram_positions' messenger_positions: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement_messenger_positions' platforms: $ref: '#/components/schemas/property_AdsReportMetrics_campaign_targeting_placement_platforms' type: object property_AdsReportMetrics_campaign_targeting_placement_audience_network_positions: items: type: string type: array property_AdsReportMetrics_campaign_targeting_placement_facebook_positions: items: type: string type: array property_AdsReportMetrics_campaign_targeting_placement_instagram_positions: items: type: string type: array property_AdsReportMetrics_campaign_targeting_placement_messenger_positions: items: type: string type: array property_AdsReportMetrics_campaign_targeting_placement_platforms: items: type: string type: array property_AdsReportMetrics_campaign_targeting_schedule: items: $ref: '#/components/schemas/AdSchedule' type: array property_AdsReportMetrics_group: properties: bid_amount: type: number bid_strategy: $ref: '#/components/schemas/property_AdsReportMetrics_group_bid_strategy' billing_event: enum: - IMPRESSIONS - LINK_CLICKS - VIDEO_VIEWS - APP_INSTALLS - ENGAGEMENT - PAGE_LIKES - MESSAGES - POST_ENGAGEMENT - PURCHASE - NONE type: string x-speakeasy-unknown-values: allow budget_allocation_type: enum: - UNSPECIFIED - AUTOMATIC - FIXED - UNLIMITED type: string x-speakeasy-unknown-values: allow budget_amount: type: number budget_max_amount: type: number budget_period: enum: - DAILY - MONTHLY - TOTAL - LIFETIME type: string x-speakeasy-unknown-values: allow budget_unit: enum: - UNSPECIFIED - CURRENCY - IMPRESSIONS type: string x-speakeasy-unknown-values: allow campaign_id: type: string created_at: format: date-time type: string creative_ids: $ref: '#/components/schemas/property_AdsReportMetrics_group_creative_ids' currency: type: string end_at: format: date-time type: string frequency_cap: $ref: '#/components/schemas/property_AdsReportMetrics_group_frequency_cap' has_eu_political_ads: type: boolean id: type: string insertionorder_id: type: string name: type: string optimization_goal: enum: - REACH - IMPRESSIONS - LINK_CLICKS - LANDING_PAGE_VIEWS - CONVERSIONS - LEAD_GENERATION - APP_INSTALLS - APP_ENGAGEMENT - VIDEO_VIEWS - ENGAGEMENT - PAGE_LIKES - MESSAGES type: string x-speakeasy-unknown-values: allow organization_id: type: string pacing: $ref: '#/components/schemas/property_AdsReportMetrics_group_pacing' parent_id: type: string promoted: $ref: '#/components/schemas/property_AdsReportMetrics_group_promoted' raw: additionalProperties: true type: object start_at: format: date-time type: string status: enum: - UNSPECIFIED - ACTIVE - PAUSED - ARCHIVED - DRAFT - SCHEDULED_FOR_DELETION type: string x-speakeasy-unknown-values: allow targeting: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting' type: enum: - TEXT - IMAGE - VIDEO - RESPONSIVE - SHOPPING - APP - CALL - CAROUSEL - SOCIAL - DISPLAY - SEARCH - AUDIO - YOUTUBE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AdsReportMetrics_group_bid_strategy: description: YOUTUBE_AND_PARTNERS properties: custom_bidding_algorithm_id: type: string fixed_bid_amount: type: number max_average_cpm_bid_amount: type: number performance_goal_amount: type: number performance_goal_type: enum: - UNSPECIFIED - CPA - CPC - VIEWABLE_CPM - CUSTOM_ALGO - CIVA - IVO_TEN - AV_VIEWED - REACH type: string x-speakeasy-unknown-values: allow raise_bid_for_deals: type: boolean target_roas: type: number type: enum: - FIXED_BID - MAXIMIZE_SPEND - PERFORMANCE_GOAL - YOUTUBE_AND_PARTNERS type: string x-speakeasy-unknown-values: allow youtube_and_partners_type: enum: - UNSPECIFIED - MANUAL_CPV - MANUAL_CPM - TARGET_CPA - TARGET_CPM - RESERVE_CPM - MAXIMIZE_LIFT - MAXIMIZE_CONVERSIONS - TARGET_CPV - TARGET_ROAS - MAXIMIZE_CONVERSION_VALUE type: string x-speakeasy-unknown-values: allow youtube_and_partners_value: type: string required: - type type: object property_AdsReportMetrics_group_creative_ids: items: type: string type: array property_AdsReportMetrics_group_frequency_cap: properties: is_unlimited: type: boolean max_impressions: type: number max_views: type: number time_unit: enum: - UNSPECIFIED - LIFETIME - MONTHS - WEEKS - DAYS - HOURS - MINUTES type: string x-speakeasy-unknown-values: allow time_unit_count: type: number type: object property_AdsReportMetrics_group_pacing: properties: daily_max_amount: type: number daily_max_impressions: type: number period: enum: - UNSPECIFIED - DAILY - FLIGHT type: string x-speakeasy-unknown-values: allow type: type: string type: object property_AdsReportMetrics_group_promoted: items: $ref: '#/components/schemas/AdsPromoted' type: array property_AdsReportMetrics_group_targeting: properties: audience: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience' brand_safety: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety' content: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content' demographic: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_demographic' device: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_device' geographic: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic' language: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_language' optimization: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_optimization' placement: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement' schedule: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_schedule' type: object property_AdsReportMetrics_group_targeting_audience: properties: behaviors: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_behaviors' combination_spec: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_combination_spec' custom_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_custom_audiences' excluded_behaviors: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_excluded_behaviors' excluded_custom_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_excluded_custom_audiences' excluded_interests: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_excluded_interests' interests: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_interests' lookalike_audiences: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_audience_lookalike_audiences' type: object property_AdsReportMetrics_group_targeting_audience_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_combination_spec: items: $ref: '#/components/schemas/AudienceCombination' type: array property_AdsReportMetrics_group_targeting_audience_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_excluded_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_excluded_custom_audiences: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_excluded_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AdsReportMetrics_group_targeting_audience_lookalike_audiences: items: $ref: '#/components/schemas/LookalikeAudience' type: array property_AdsReportMetrics_group_targeting_brand_safety: description: 'Brand safety (Meta: excluded_publisher_categories, etc.; Google' properties: block_list_ids: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety_block_list_ids' brand_safety_content_filter_levels: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety_brand_safety_content_filter_levels' excluded_content_labels: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety_excluded_content_labels' excluded_publisher_categories: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety_excluded_publisher_categories' publisher_visibility_categories: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_brand_safety_publisher_visibility_categories' type: object property_AdsReportMetrics_group_targeting_brand_safety_block_list_ids: items: type: string type: array property_AdsReportMetrics_group_targeting_brand_safety_brand_safety_content_filter_levels: items: type: string type: array property_AdsReportMetrics_group_targeting_brand_safety_excluded_content_labels: description: Google Ads ContentLabelType items: type: string type: array property_AdsReportMetrics_group_targeting_brand_safety_excluded_publisher_categories: items: type: string type: array property_AdsReportMetrics_group_targeting_brand_safety_publisher_visibility_categories: items: enum: - limited - standard - expanded type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_group_targeting_content: properties: excluded_keywords: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_excluded_keywords' excluded_topics: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_excluded_topics' excluded_urls: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_excluded_urls' keywords: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_keywords' topics: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_topics' urls: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_urls' video: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video' type: object property_AdsReportMetrics_group_targeting_content_excluded_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsReportMetrics_group_targeting_content_excluded_topics: items: type: string type: array property_AdsReportMetrics_group_targeting_content_excluded_urls: items: type: string type: array property_AdsReportMetrics_group_targeting_content_keywords: items: $ref: '#/components/schemas/AdsKeyword' type: array property_AdsReportMetrics_group_targeting_content_topics: items: type: string type: array property_AdsReportMetrics_group_targeting_content_urls: items: type: string type: array property_AdsReportMetrics_group_targeting_content_video: properties: durations: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_durations' excluded_youtube_channels: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_excluded_youtube_channels' excluded_youtube_videos: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_excluded_youtube_videos' player_sizes: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_player_sizes' positions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_positions' youtube_channels: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_youtube_channels' youtube_videos: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_content_video_youtube_videos' type: object property_AdsReportMetrics_group_targeting_content_video_durations: items: enum: - SHORT - MEDIUM - LONG type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_group_targeting_content_video_excluded_youtube_channels: items: type: string type: array property_AdsReportMetrics_group_targeting_content_video_excluded_youtube_videos: items: type: string type: array property_AdsReportMetrics_group_targeting_content_video_player_sizes: items: enum: - SMALL - LARGE - HD type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_group_targeting_content_video_positions: items: enum: - PREROLL - MIDROLL - POSTROLL - INSTREAM - OUTSTREAM type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_group_targeting_content_video_youtube_channels: items: type: string type: array property_AdsReportMetrics_group_targeting_content_video_youtube_videos: items: type: string type: array property_AdsReportMetrics_group_targeting_demographic: description: 'Demographic targeting (Meta: age_min, age_max, genders)' properties: age_max: type: number age_min: type: number female: type: boolean male: type: boolean type: object property_AdsReportMetrics_group_targeting_device: properties: carriers: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_device_carriers' types: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_device_types' user_device: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_device_user_device' user_os: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_device_user_os' type: object property_AdsReportMetrics_group_targeting_device_carriers: items: type: string type: array property_AdsReportMetrics_group_targeting_device_types: items: type: string type: array property_AdsReportMetrics_group_targeting_device_user_device: items: type: string type: array property_AdsReportMetrics_group_targeting_device_user_os: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic: properties: cities: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_cities' countries: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_countries' excluded_cities: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_excluded_cities' excluded_countries: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_excluded_countries' excluded_postal_codes: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_excluded_postal_codes' excluded_regions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_excluded_regions' excluded_us_dmas: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_excluded_us_dmas' location_types: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_location_types' postal_codes: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_postal_codes' presence_type: enum: - PRESENCE - PRESENCE_OR_INTEREST type: string x-speakeasy-unknown-values: allow regions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_regions' us_dmas: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_geographic_us_dmas' type: object property_AdsReportMetrics_group_targeting_geographic_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsReportMetrics_group_targeting_geographic_countries: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic_excluded_cities: items: $ref: '#/components/schemas/CityTarget' type: array property_AdsReportMetrics_group_targeting_geographic_excluded_countries: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic_excluded_postal_codes: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic_excluded_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsReportMetrics_group_targeting_geographic_excluded_us_dmas: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic_location_types: items: enum: - HOME - RECENT - TRAVEL type: string x-speakeasy-unknown-values: allow type: array property_AdsReportMetrics_group_targeting_geographic_postal_codes: items: type: string type: array property_AdsReportMetrics_group_targeting_geographic_regions: items: $ref: '#/components/schemas/RegionTarget' type: array property_AdsReportMetrics_group_targeting_geographic_us_dmas: items: type: string type: array property_AdsReportMetrics_group_targeting_language: description: Language targeting (Meta properties: codes: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_language_codes' locale_ids: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_language_locale_ids' type: object property_AdsReportMetrics_group_targeting_language_codes: items: type: string type: array property_AdsReportMetrics_group_targeting_language_locale_ids: items: type: number type: array property_AdsReportMetrics_group_targeting_optimization: description: 'Optimization (Meta: targeting_automation; Google: observation vs targeting mode)' properties: advantage_audience: type: boolean advantage_placements: type: boolean mode: enum: - TARGETING - OBSERVATION type: string x-speakeasy-unknown-values: allow targeting_optimization_expansion_all: type: boolean type: object property_AdsReportMetrics_group_targeting_placement: properties: audience_network_positions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement_audience_network_positions' facebook_positions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement_facebook_positions' instagram_positions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement_instagram_positions' messenger_positions: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement_messenger_positions' platforms: $ref: '#/components/schemas/property_AdsReportMetrics_group_targeting_placement_platforms' type: object property_AdsReportMetrics_group_targeting_placement_audience_network_positions: items: type: string type: array property_AdsReportMetrics_group_targeting_placement_facebook_positions: items: type: string type: array property_AdsReportMetrics_group_targeting_placement_instagram_positions: items: type: string type: array property_AdsReportMetrics_group_targeting_placement_messenger_positions: items: type: string type: array property_AdsReportMetrics_group_targeting_placement_platforms: items: type: string type: array property_AdsReportMetrics_group_targeting_schedule: items: $ref: '#/components/schemas/AdSchedule' type: array property_AdsReport_metrics: items: $ref: '#/components/schemas/AdsReportMetrics' type: array property_AssessmentOrder_parameters: description: Filled-in answers to the package's parameter questions items: $ref: '#/components/schemas/AssessmentParameterInput' type: array property_AssessmentOrder_profile_addresses: items: $ref: '#/components/schemas/AssessmentAddress' type: array property_AssessmentOrder_profile_emails: items: type: string type: array property_AssessmentOrder_profile_social_media_urls: items: type: string type: array property_AssessmentOrder_profile_telephones: items: type: string type: array property_AssessmentOrder_response_attributes: description: Additional result attributes items: $ref: '#/components/schemas/AssessmentAttribute' type: array property_AssessmentOrder_response_details: items: $ref: '#/components/schemas/AssessmentResponseDetail' type: array property_AssessmentOrder_response_download_urls: description: Report download URLs items: type: string type: array property_AssessmentPackageRegion_regions: description: Countryregion codes where this package is available ({country}-{state} or {country}) items: type: string type: array property_AssessmentPackage_aliases: description: Alternative namesidentifiers for this package items: type: string type: array property_AssessmentPackage_integration_types: description: Integration types that support this package items: type: string type: array property_AssessmentPackage_parameters: description: Questionsinputs needed for this assessment (aligned with verification) items: $ref: '#/components/schemas/AssessmentParameter' type: array property_AssessmentPackage_regions: items: $ref: '#/components/schemas/AssessmentPackageRegion' type: array property_AssessmentPackage_tags: description: Category tags (e.g., "Assessment", "Background Check") items: type: string type: array property_AssessmentParameterInput_inputs: items: type: string type: array property_AssessmentParameter_file_types: description: Valid file MIME types for FILE type items: type: string type: array property_AssessmentParameter_options: description: Options for MULTIPLE_CHOICE and MULTIPLE_SELECT items: type: string type: array property_AssessmentParameter_valid_regions: description: Regions where this parameter is valid ({country}-{state} or {country}) items: type: string type: array property_AtsActivity_bcc: items: $ref: '#/components/schemas/AtsEmail' type: array property_AtsActivity_cc: items: $ref: '#/components/schemas/AtsEmail' type: array property_AtsActivity_document_ids: description: IDs for AtsDocument.get items: type: string type: array property_AtsActivity_from: properties: email: type: string name: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object property_AtsActivity_to: items: $ref: '#/components/schemas/AtsEmail' type: array property_AtsActivity_user_ids: description: id values of the recruiters associated with the activity. items: type: string type: array property_AtsApplicationAnswer_answers: items: type: string type: array property_AtsApplication_answers: items: $ref: '#/components/schemas/AtsApplicationAnswer' type: array property_AtsApplication_metadata: items: $ref: '#/components/schemas/AtsMetadata' type: array property_AtsApplication_offers: items: $ref: '#/components/schemas/AtsOffer' type: array property_AtsCandidate_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AtsCandidate_education: items: $ref: '#/components/schemas/AtsCandidateEducation' type: array property_AtsCandidate_emails: items: $ref: '#/components/schemas/AtsEmail' type: array property_AtsCandidate_experiences: items: $ref: '#/components/schemas/AtsCandidateExperience' type: array property_AtsCandidate_link_urls: description: URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.) items: type: string type: array property_AtsCandidate_metadata: items: $ref: '#/components/schemas/AtsMetadata' type: array property_AtsCandidate_skills: items: type: string type: array property_AtsCandidate_sources: items: type: string type: array property_AtsCandidate_tags: items: type: string type: array property_AtsCandidate_telephones: items: $ref: '#/components/schemas/AtsTelephone' type: array property_AtsCompany_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AtsCompany_metadata: items: $ref: '#/components/schemas/AtsMetadata' type: array property_AtsCompany_recruiter_ids: items: type: string type: array property_AtsInterview_user_ids: items: type: string type: array property_AtsJobPosting_address: description: job-post-specific address properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AtsJobQuestion_options: items: type: string type: array property_AtsJob_addresses: items: $ref: '#/components/schemas/AtsAddress' type: array property_AtsJob_compensation: items: $ref: '#/components/schemas/AtsCompensation' type: array property_AtsJob_groups: description: The departments/divisions/teams that this job belongs to items: $ref: '#/components/schemas/AtsGroup' type: array property_AtsJob_hiring_manager_ids: items: type: string type: array property_AtsJob_hiring_managers: items: $ref: '#/components/schemas/AtsReference' type: array property_AtsJob_metadata: items: $ref: '#/components/schemas/AtsMetadata' type: array property_AtsJob_openings: items: $ref: '#/components/schemas/AtsJobOpening' type: array property_AtsJob_postings: description: Public job postings items: $ref: '#/components/schemas/AtsJobPosting' type: array property_AtsJob_public_job_urls: description: URLs for pages containing public listings for the job items: type: string type: array property_AtsJob_questions: items: $ref: '#/components/schemas/AtsJobQuestion' type: array property_AtsJob_recruiter_ids: items: type: string type: array property_AtsJob_skills: items: type: string type: array property_AtsOffer_compensation: description: compensation details for the offer items: $ref: '#/components/schemas/AtsCompensation' type: array property_AtsScorecard_questions: items: $ref: '#/components/schemas/AtsScorecardQuestion' type: array property_AudienceCombination_behaviors: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AudienceCombination_demographics: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AudienceCombination_interests: items: $ref: '#/components/schemas/AudienceSegment' type: array property_AudienceCombination_life_events: items: $ref: '#/components/schemas/AudienceSegment' type: array property_CalendarEventRecurrence_excluded_dates: description: dates to exclude from the recurrence, defaults to undefined (no exclusions) items: type: string type: array property_CalendarEventRecurrence_included_dates: description: dates to include in the recurrence, defaults to undefined (no inclusions) items: type: string type: array property_CalendarEventRecurrence_on_days: description: days of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY items: enum: - SU - MO - TU - WE - TH - FR - SA type: string x-speakeasy-unknown-values: allow type: array property_CalendarEventRecurrence_on_month_days: description: days of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY items: type: number type: array property_CalendarEventRecurrence_on_months: description: months of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1 items: type: number type: array property_CalendarEventRecurrence_on_weeks: description: week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals. items: type: number type: array property_CalendarEventRecurrence_on_year_days: description: days of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY items: type: number type: array property_CalendarEvent_attachments: items: $ref: '#/components/schemas/CalendarAttachment' type: array property_CalendarEvent_attendees: items: $ref: '#/components/schemas/CalendarAttendee' type: array property_CalendarEvent_conference: items: $ref: '#/components/schemas/CalendarConference' type: array property_CalendarEvent_organizer: properties: email: type: string is_cohost: type: boolean name: type: string required: type: boolean status: enum: - ACCEPTED - REJECTED - TENTATIVE type: string x-speakeasy-unknown-values: allow user_id: type: string type: object property_CalendarEvent_recurrence: items: $ref: '#/components/schemas/CalendarEventRecurrence' type: array property_CalendarRecordingMedia_attendees: items: $ref: '#/components/schemas/CalendarAttendee' type: array property_CalendarRecordingMedia_transcripts: items: $ref: '#/components/schemas/CalendarRecordingTranscript' type: array property_CalendarRecordingTranscript_attendee: properties: email: type: string is_cohost: type: boolean name: type: string required: type: boolean status: enum: - ACCEPTED - REJECTED - TENTATIVE type: string x-speakeasy-unknown-values: allow user_id: type: string type: object property_CalendarRecording_media: items: $ref: '#/components/schemas/CalendarRecordingMedia' type: array property_CalendarWebinar_conference: items: $ref: '#/components/schemas/CalendarConference' type: array property_CalendarWebinar_organizer: properties: email: type: string is_cohost: type: boolean name: type: string required: type: boolean status: enum: - ACCEPTED - REJECTED - TENTATIVE type: string x-speakeasy-unknown-values: allow user_id: type: string type: object property_CalendarWebinar_panelists: items: $ref: '#/components/schemas/CalendarWebinarPanelist' type: array property_CalendarWebinar_recurrence: items: $ref: '#/components/schemas/CalendarEventRecurrence' type: array property_CalendarWebinar_registrants: items: $ref: '#/components/schemas/CalendarWebinarRegistrant' type: array property_CommerceCollection_item_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceCollection_media: items: $ref: '#/components/schemas/CommerceItemMedia' type: array property_CommerceCollection_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceCollection_tags: items: type: string type: array property_CommerceItemMedia_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceItemOption_values: items: type: string type: array property_CommerceItem_collection_ids: description: ' @deprecated; use collections instead' items: type: string type: array property_CommerceItem_collections: description: points to Collection with id, name, and type fields items: $ref: '#/components/schemas/CommerceReference' type: array property_CommerceItem_media: items: $ref: '#/components/schemas/CommerceItemMedia' type: array property_CommerceItem_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceItem_prices: items: $ref: '#/components/schemas/CommerceItemPrice' type: array property_CommerceItem_tags: items: type: string type: array property_CommerceItem_variants: description: first variant is the default variant items: $ref: '#/components/schemas/CommerceItemvariant' type: array property_CommerceItemvariant_items: description: references CommerceItem items: $ref: '#/components/schemas/CommerceReference' type: array property_CommerceItemvariant_media: items: $ref: '#/components/schemas/CommerceItemMedia' type: array property_CommerceItemvariant_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceItemvariant_options: items: $ref: '#/components/schemas/CommerceItemOption' type: array property_CommerceItemvariant_prices: items: $ref: '#/components/schemas/CommerceItemPrice' type: array property_CommerceItemvariant_tags: items: type: string type: array property_CommerceLocation_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_CommerceLocation_categories: items: type: string type: array property_CommerceLocation_media: items: $ref: '#/components/schemas/CommerceItemMedia' type: array property_CommerceLocation_telephones: items: $ref: '#/components/schemas/CommerceTelephone' type: array property_CommerceReviewComment_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceReview_comments: items: $ref: '#/components/schemas/CommerceReviewComment' type: array property_CommerceReview_media: description: Photosvideos attached to the review items: $ref: '#/components/schemas/CommerceItemMedia' type: array property_CommerceReview_metadata: items: $ref: '#/components/schemas/CommerceMetadata' type: array property_CommerceSaleschannel_collections: description: points to a CommerceCollection items: $ref: '#/components/schemas/CommerceReference' type: array property_Connection_auth: description: An authentication object that represents a specific authorized user's connection to an integration. properties: access_token: type: string api_url: type: string app_id: type: string audience: type: string authorize_url: type: string client_id: type: string client_secret: type: string consumer_key: type: string consumer_secret: type: string dev_api_key: type: string emails: $ref: '#/components/schemas/property_Connection_auth_emails' expires_in: type: number expiry_date: format: date-time type: string key: type: string meta: additionalProperties: true type: object name: type: string other_auth_info: $ref: '#/components/schemas/property_Connection_auth_other_auth_info' pem: type: string refresh_token: type: string refresh_token_expires_date: format: date-time type: string refresh_token_expires_in: type: number refresh_url: type: string state: type: string token: type: string token_url: type: string user_id: type: string type: object property_Connection_auth_emails: items: type: string type: array property_Connection_auth_other_auth_info: description: When integration.auth_type = "other", this field contains the authentication credentials in the same order as token_names items: type: string type: array property_Connection_categories: description: The Integration categories that this connection supports items: enum: - passthrough - hris - ats - auth - crm - enrich - martech - ticketing - uc - accounting - storage - commerce - payment - genai - messaging - kms - task - scim - lms - repo - metadata - calendar - verification - ads - forms - shipping - assessment - signing type: string x-speakeasy-unknown-values: allow type: array property_Connection_permissions: items: enum: - accounting_account_read - accounting_account_write - accounting_transaction_read - accounting_transaction_write - accounting_journal_read - accounting_journal_write - accounting_invoice_read - accounting_invoice_write - accounting_bill_read - accounting_bill_write - accounting_creditmemo_read - accounting_creditmemo_write - accounting_contact_read - accounting_contact_write - accounting_expense_read - accounting_expense_write - accounting_taxrate_read - accounting_taxrate_write - accounting_organization_read - accounting_order_read - accounting_order_write - accounting_purchaseorder_read - accounting_purchaseorder_write - accounting_salesorder_read - accounting_salesorder_write - accounting_report_read - accounting_report_write - accounting_trialbalance_read - accounting_trialbalance_write - accounting_profitloss_read - accounting_profitloss_write - accounting_balancesheet_read - accounting_balancesheet_write - accounting_category_read - accounting_category_write - payment_payment_read - payment_payment_write - accounting_cashflow_read - accounting_cashflow_write - payment_payout_read - payment_refund_read - payment_link_read - payment_link_write - payment_subscription_read - payment_subscription_write - commerce_item_read - commerce_item_write - commerce_collection_read - commerce_collection_write - commerce_inventory_read - commerce_inventory_write - commerce_location_read - commerce_location_write - commerce_review_read - commerce_review_write - commerce_saleschannel_read - commerce_saleschannel_write - commerce_itemvariant_read - commerce_itemvariant_write - commerce_reservation_read - commerce_reservation_write - commerce_availability_read - commerce_availability_write - verification_package_read - verification_request_read - verification_request_write - assessment_package_read - assessment_package_write - assessment_order_write - ats_activity_read - ats_activity_write - ats_application_read - ats_application_write - ats_applicationstatus_read - ats_candidate_read - ats_candidate_write - ats_interview_read - ats_interview_write - ats_job_read - ats_job_write - ats_company_read - ats_company_write - ats_document_read - ats_document_write - ats_scorecard_read - ats_scorecard_write - crm_company_read - crm_company_write - crm_contact_read - crm_contact_write - crm_deal_read - crm_deal_write - crm_event_read - crm_event_write - crm_lead_read - crm_lead_write - crm_pipeline_read - crm_pipeline_write - martech_list_read - martech_list_write - martech_member_read - martech_member_write - martech_campaign_read - martech_campaign_write - martech_report_read - martech_report_write - ticketing_customer_read - ticketing_customer_write - ticketing_ticket_read - ticketing_ticket_write - ticketing_note_read - ticketing_note_write - ticketing_category_read - ticketing_category_write - hris_employee_read - hris_employee_write - hris_group_read - hris_group_write - hris_payslip_read - hris_payslip_write - hris_timeoff_read - hris_timeoff_write - hris_timeshift_read - hris_timeshift_write - hris_company_read - hris_company_write - hris_location_read - hris_location_write - hris_device_read - hris_device_write - hris_deduction_read - hris_deduction_write - hris_benefit_read - hris_benefit_write - hris_bankaccount_read - hris_bankaccount_write - uc_call_read - uc_contact_read - uc_contact_write - uc_comment_read - uc_comment_write - uc_recording_read - storage_file_read - storage_file_write - webhook - genai_model_read - genai_prompt_read - genai_prompt_write - genai_embedding_read - genai_embedding_write - messaging_message_read - messaging_message_write - messaging_channel_read - messaging_event_read - messaging_event_write - kms_space_read - kms_space_write - kms_page_read - kms_page_write - kms_comment_read - kms_comment_write - task_project_read - task_project_write - task_task_read - task_task_write - task_change_read - task_comment_read - task_comment_write - scim_users_read - scim_users_write - scim_groups_read - scim_groups_write - lms_course_read - lms_course_write - lms_class_read - lms_class_write - lms_student_read - lms_student_write - lms_instructor_read - lms_instructor_write - lms_content_read - lms_content_write - lms_collection_read - lms_collection_write - lms_activity_read - lms_activity_write - repo_organization_read - repo_organization_write - repo_repository_read - repo_repository_write - repo_branch_read - repo_branch_write - repo_commit_read - repo_commit_write - repo_pullrequest_read - repo_pullrequest_write - metadata_metadata_read - metadata_metadata_write - calendar_calendar_read - calendar_calendar_write - calendar_event_read - calendar_event_write - calendar_busy_read - calendar_link_read - calendar_link_write - calendar_recording_read - calendar_recording_write - calendar_webinar_read - calendar_webinar_write - enrich_person_read - enrich_company_read - ads_ad_read - ads_ad_write - ads_campaign_read - ads_campaign_write - ads_group_read - ads_group_write - ads_report_read - ads_organization_read - ads_organization_write - ads_creative_read - ads_creative_write - ads_insertionorder_read - ads_insertionorder_write - ads_target_read - ads_promoted_read - forms_form_read - forms_form_write - forms_submission_read - forms_submission_write - shipping_shipment_read - shipping_shipment_write - shipping_label_read - shipping_label_write - shipping_tracking_read - shipping_rate_read - shipping_carrier_read - signing_document_read - signing_document_write - signing_signatory_read - signing_signatory_write - signing_template_read type: string x-speakeasy-unknown-values: allow type: array property_CrmCompany_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_CrmCompany_contact_ids: description: An array of contact IDs associated with this company items: type: string type: array property_CrmCompany_deal_ids: description: An array of deal IDs associated with this contact items: type: string type: array property_CrmCompany_domains: items: type: string type: array property_CrmCompany_emails: items: $ref: '#/components/schemas/CrmEmail' type: array property_CrmCompany_link_urls: description: Additional URLs associated with the contact e.g., LinkedIn, website, etc items: type: string type: array property_CrmCompany_metadata: items: $ref: '#/components/schemas/CrmMetadata' type: array property_CrmCompany_tags: items: type: string type: array property_CrmCompany_telephones: items: $ref: '#/components/schemas/CrmTelephone' type: array property_CrmCompany_websites: items: type: string type: array property_CrmContact_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_CrmContact_company_ids: description: An array of company IDs associated with this contact items: type: string type: array property_CrmContact_deal_ids: description: An array of deal IDs associated with this contact items: type: string type: array property_CrmContact_emails: description: An array of email addresses for this contact items: $ref: '#/components/schemas/CrmEmail' type: array property_CrmContact_link_urls: description: Additional URLs associated with the contact e.g., LinkedIn, website, etc items: type: string type: array property_CrmContact_metadata: items: $ref: '#/components/schemas/CrmMetadata' type: array property_CrmContact_telephones: description: An array of telephones for this contact items: $ref: '#/components/schemas/CrmTelephone' type: array property_CrmDeal_company_ids: items: type: string type: array property_CrmDeal_contact_ids: items: type: string type: array property_CrmDeal_metadata: items: $ref: '#/components/schemas/CrmMetadata' type: array property_CrmDeal_pipelines: items: $ref: '#/components/schemas/CrmReference' type: array property_CrmDeal_stages: items: $ref: '#/components/schemas/CrmReference' type: array property_CrmDeal_tags: items: type: string type: array property_CrmEventFormField_options: items: $ref: '#/components/schemas/CrmEventFormOption' type: array property_CrmEvent_call: description: The call object, when type = call properties: description: type: string duration: type: number start_at: format: date-time type: string type: object property_CrmEvent_company_ids: description: An array of company IDs associated with this event items: type: string type: array property_CrmEvent_contact_ids: description: An array of contact IDs associated with this event items: type: string type: array property_CrmEvent_deal_ids: description: An array of deal IDs associated with this event items: type: string type: array property_CrmEvent_email: description: The email object, when type = email properties: attachment_file_ids: $ref: '#/components/schemas/property_CrmEvent_email_attachment_file_ids' body: type: string cc: $ref: '#/components/schemas/property_CrmEvent_email_cc' from: type: string subject: type: string to: $ref: '#/components/schemas/property_CrmEvent_email_to' type: object property_CrmEvent_email_attachment_file_ids: items: type: string type: array property_CrmEvent_email_cc: description: The event email's cc name & email (name ) items: type: string type: array property_CrmEvent_email_to: description: The event email's "to" name & email (name ) items: type: string type: array property_CrmEvent_form: properties: archived_at: format: date-time type: string fields: $ref: '#/components/schemas/property_CrmEvent_form_fields' name: type: string redirect_url: type: string type: object property_CrmEvent_form_fields: items: $ref: '#/components/schemas/CrmEventFormField' type: array property_CrmEvent_lead_ids: items: type: string type: array property_CrmEvent_marketing_email: properties: attachment_file_ids: $ref: '#/components/schemas/property_CrmEvent_marketing_email_attachment_file_ids' body: type: string cc: $ref: '#/components/schemas/property_CrmEvent_marketing_email_cc' from: type: string name: type: string subject: type: string to: $ref: '#/components/schemas/property_CrmEvent_marketing_email_to' type: object property_CrmEvent_marketing_email_attachment_file_ids: items: type: string type: array property_CrmEvent_marketing_email_cc: description: The event email's cc name & email (name ) items: type: string type: array property_CrmEvent_marketing_email_to: description: The event email's "to" name & email (name ) items: type: string type: array property_CrmEvent_meeting: description: The meeting object, when type = meeting properties: description: type: string end_at: format: date-time type: string start_at: format: date-time type: string title: type: string type: object property_CrmEvent_note: description: The note object, when type = note properties: description: type: string title: type: string type: object property_CrmEvent_page_view: properties: average: type: number count: type: number url: type: string type: object property_CrmEvent_task: description: The task object, when type = task properties: description: type: string due_at: format: date-time type: string name: type: string priority: enum: - HIGH - MEDIUM - LOW type: string x-speakeasy-unknown-values: allow status: enum: - COMPLETED - NOT_STARTED - WORK_IN_PROGRESS - DEFERRED type: string x-speakeasy-unknown-values: allow type: object property_CrmLead_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_CrmLead_emails: items: $ref: '#/components/schemas/CrmEmail' type: array property_CrmLead_link_urls: items: type: string type: array property_CrmLead_metadata: items: $ref: '#/components/schemas/CrmMetadata' type: array property_CrmLead_telephones: items: $ref: '#/components/schemas/CrmTelephone' type: array property_CrmPipeline_stages: items: $ref: '#/components/schemas/CrmStage' type: array property_EnrichCompany_address: description: The address of the company properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_EnrichCompany_telephones: description: An array of telephones for this company items: $ref: '#/components/schemas/EnrichTelephone' type: array property_EnrichPerson_address: description: The address of the person properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_EnrichPerson_emails: description: An array of email addresses for this person items: $ref: '#/components/schemas/EnrichEmail' type: array property_EnrichPerson_telephones: description: An array of telephones for this person items: $ref: '#/components/schemas/EnrichTelephone' type: array property_EnrichPerson_work_histories: items: $ref: '#/components/schemas/EnrichPersonWorkHistory' type: array property_FormAnswer_file_ids: description: references StorageFile ID items: type: string type: array property_FormField_choices: description: For select/radio/checkbox fields items: type: string type: array property_FormsForm_fields: items: $ref: '#/components/schemas/FormField' type: array property_FormsSubmission_answers: items: $ref: '#/components/schemas/FormAnswer' type: array property_GenaiEmbedding_content: items: $ref: '#/components/schemas/GenaiEmbeddingContent' type: array property_GenaiPrompt_mcp_deferred_tools: items: type: string type: array property_GenaiPrompt_messages: items: $ref: '#/components/schemas/GenaiContent' type: array property_GenaiPrompt_responses: items: type: string type: array property_HrisCompany_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_HrisDevice_admin_user_ids: items: type: string type: array property_HrisDevice_user_ids: description: users who have this device items: type: string type: array property_HrisEmployee_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_HrisEmployee_compensation: items: $ref: '#/components/schemas/HrisCompensation' type: array property_HrisEmployee_emails: items: $ref: '#/components/schemas/HrisEmail' type: array property_HrisEmployee_employee_roles: items: enum: - ADMIN - MANAGER - RECRUITER - SALESREP - INTERVIEWER type: string x-speakeasy-unknown-values: allow type: array property_HrisEmployee_groups: description: Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email. items: $ref: '#/components/schemas/HrisGroup' type: array property_HrisEmployee_locations: items: $ref: '#/components/schemas/HrisLocation' type: array property_HrisEmployee_metadata: items: $ref: '#/components/schemas/HrisMetadata' type: array property_HrisEmployee_relationships: description: the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...) items: $ref: '#/components/schemas/HrisEmployeerelationship' type: array property_HrisEmployee_telephones: items: $ref: '#/components/schemas/HrisTelephone' type: array property_HrisEmployeerelationship_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_HrisEmployeerelationship_emails: items: $ref: '#/components/schemas/HrisEmail' type: array property_HrisEmployeerelationship_telephones: items: $ref: '#/components/schemas/HrisTelephone' type: array property_HrisGroup_manager_ids: items: type: string type: array property_HrisGroup_user_ids: items: type: string type: array property_HrisLocation_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_HrisLocation_telephones: items: $ref: '#/components/schemas/HrisTelephone' type: array property_HrisPayslip_deduction: description: The ID (and optionally name) of the employee deduction (if this detail represents a deduction) properties: amount: type: number benefit_id: type: string company_id: type: string coverage_level: enum: - EMPLOYEE_ONLY - EMPLOYEE_SPOUSE - EMPLOYEE_CHILD - EMPLOYEE_CHILDREN - EMPLOYEE_FAMILY - FAMILY - OTHER type: string x-speakeasy-unknown-values: allow created_at: format: date-time type: string end_at: format: date-time type: string frequency: enum: - ONE_TIME - DAY - QUARTER - YEAR - HOUR - MONTH - WEEK type: string x-speakeasy-unknown-values: allow id: type: string is_active: type: boolean notes: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string type: enum: - FIXED - PERCENTAGE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object property_HrisPayslip_details: items: $ref: '#/components/schemas/HrisPayslipDetail' type: array property_HrisTimeshift_compensation: items: $ref: '#/components/schemas/HrisCompensation' type: array property_IntegrationSupport_inbound_fields: additionalProperties: type: string type: object property_IntegrationSupport_methods: additionalProperties: type: boolean type: object property_IntegrationSupport_outbound_fields: additionalProperties: type: string type: object property_IntegrationSupport_raw_objects: description: objects that we map from in the integration items: type: string type: array property_IntegrationSupport_slow_fields: items: type: string type: array property_IntegrationSupport_webhook_events: properties: created: $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_created' deleted: $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_deleted' updated: $ref: '#/components/schemas/property_IntegrationSupport_webhook_events_updated' type: object property_IntegrationSupport_webhook_events_created: items: enum: - virtual - native type: string x-speakeasy-unknown-values: allow type: array property_IntegrationSupport_webhook_events_deleted: items: enum: - virtual - native type: string x-speakeasy-unknown-values: allow type: array property_IntegrationSupport_webhook_events_updated: items: enum: - virtual - native type: string x-speakeasy-unknown-values: allow type: array property_Integration_categories: description: The categories of support solutions that this integration has items: enum: - passthrough - hris - ats - auth - crm - enrich - martech - ticketing - uc - accounting - storage - commerce - payment - genai - messaging - kms - task - scim - lms - repo - metadata - calendar - verification - ads - forms - shipping - assessment - signing type: string x-speakeasy-unknown-values: allow type: array property_Integration_support: additionalProperties: $ref: '#/components/schemas/IntegrationSupport' type: object property_Integration_token_instructions: description: instructions for the user on how to find the token/key items: type: string type: array property_Integration_token_names: description: if auth_types = 'token' items: type: string type: array property_Issue_type: items: type: string type: array property_KmsPage_metadata: items: $ref: '#/components/schemas/KmsPageMetadata' type: array property_LmsClass_instructor_ids: items: type: string type: array property_LmsClass_languages: items: type: string type: array property_LmsClass_media: items: $ref: '#/components/schemas/LmsMedia' type: array property_LmsClass_student_ids: items: type: string type: array property_LmsCollection_media: items: $ref: '#/components/schemas/LmsMedia' type: array property_LmsContent_categories: items: type: string type: array property_LmsContent_collection_ids: items: type: string type: array property_LmsContent_course_ids: items: type: string type: array property_LmsContent_instructor_ids: items: type: string type: array property_LmsContent_languages: items: type: string type: array property_LmsContent_localizations: items: $ref: '#/components/schemas/LmsContentLocalization' type: array property_LmsContent_media: items: $ref: '#/components/schemas/LmsMedia' type: array property_LmsContent_skills: items: type: string type: array property_LmsCourse_categories: items: type: string type: array property_LmsCourse_content_ids: items: type: string type: array property_LmsCourse_instructor_ids: description: '@deprecated; use instructors' items: type: string type: array property_LmsCourse_instructors: items: $ref: '#/components/schemas/LmsInstructor' type: array property_LmsCourse_languages: items: type: string type: array property_LmsCourse_media: items: $ref: '#/components/schemas/LmsMedia' type: array property_LmsCourse_skills: items: type: string type: array property_LmsCourse_student_ids: description: '@deprecated; use students' items: type: string type: array property_LmsCourse_students: items: $ref: '#/components/schemas/LmsStudent' type: array property_LmsInstructor_emails: items: $ref: '#/components/schemas/LmsEmail' type: array property_LmsInstructor_telephones: items: $ref: '#/components/schemas/LmsTelephone' type: array property_LmsMedia_languages: description: ISO 2-digit language codes items: type: string type: array property_LmsStudent_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_LmsStudent_emails: items: $ref: '#/components/schemas/LmsEmail' type: array property_LmsStudent_telephones: items: $ref: '#/components/schemas/LmsTelephone' type: array property_MarketingCampaign_list_ids: description: Associated listaudience IDs items: type: string type: array property_MarketingList_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_MarketingMember_emails: description: An array of email addresses for this member items: $ref: '#/components/schemas/MarketingEmail' type: array property_MarketingMember_list_ids: description: An array of list IDs associated with this member items: type: string type: array property_MarketingMember_tags: description: An array of tags associated with this member items: type: string type: array property_MarketingReport_links: description: URL-specific click data items: $ref: '#/components/schemas/MarketingReportLink' type: array property_MessagingChannel_members: items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingEvent_button: properties: icon: type: string id: type: string text: type: string required: - id type: object property_MessagingEvent_channel: properties: created_at: format: date-time type: string description: type: string has_subchannels: type: boolean id: type: string is_active: type: boolean is_private: type: boolean members: $ref: '#/components/schemas/property_MessagingEvent_channel_members' name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string web_url: type: string required: - name type: object property_MessagingEvent_channel_members: items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingEvent_message: properties: attachments: $ref: '#/components/schemas/property_MessagingEvent_message_attachments' author_member: $ref: '#/components/schemas/property_MessagingEvent_message_author_member' buttons: $ref: '#/components/schemas/property_MessagingEvent_message_buttons' channel_id: type: string channel_ids: $ref: '#/components/schemas/property_MessagingEvent_message_channel_ids' channels: $ref: '#/components/schemas/property_MessagingEvent_message_channels' created_at: format: date-time type: string destination_members: $ref: '#/components/schemas/property_MessagingEvent_message_destination_members' has_children: type: boolean hidden_members: $ref: '#/components/schemas/property_MessagingEvent_message_hidden_members' id: type: string is_unread: type: boolean mentioned_members: $ref: '#/components/schemas/property_MessagingEvent_message_mentioned_members' message: type: string message_html: type: string message_markdown: type: string message_thread_identifier: type: string parent_id: type: string raw: additionalProperties: true type: object reactions: $ref: '#/components/schemas/property_MessagingEvent_message_reactions' reference: type: string root_message_id: type: string subject: type: string updated_at: format: date-time type: string web_url: type: string type: object property_MessagingEvent_message_attachments: items: $ref: '#/components/schemas/MessagingAttachment' type: array property_MessagingEvent_message_author_member: description: for email systems, this field represents the From value properties: email: type: string image_url: type: string name: type: string user_id: type: string type: object property_MessagingEvent_message_buttons: items: $ref: '#/components/schemas/MessagingButton' type: array property_MessagingEvent_message_channel_ids: description: '@deprecated; use channels instead' items: type: string type: array property_MessagingEvent_message_channels: description: Represents the names of all channels to which the message is sent. Identifies the channels where the message is posted. items: $ref: '#/components/schemas/MessagingReference' type: array property_MessagingEvent_message_destination_members: description: for email systems, this field represents the To value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingEvent_message_hidden_members: description: for email systems, this field represents the BCC value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingEvent_message_mentioned_members: description: for email systems, this field represents the CC value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingEvent_message_reactions: items: $ref: '#/components/schemas/MessagingReaction' type: array property_MessagingEvent_user: properties: id: type: string name: type: string type: object property_MessagingMessage_attachments: items: $ref: '#/components/schemas/MessagingAttachment' type: array property_MessagingMessage_author_member: description: for email systems, this field represents the From value properties: email: type: string image_url: type: string name: type: string user_id: type: string type: object property_MessagingMessage_buttons: items: $ref: '#/components/schemas/MessagingButton' type: array property_MessagingMessage_channel_ids: description: '@deprecated; use channels instead' items: type: string type: array property_MessagingMessage_channels: description: Represents the names of all channels to which the message is sent. Identifies the channels where the message is posted. items: $ref: '#/components/schemas/MessagingReference' type: array property_MessagingMessage_destination_members: description: for email systems, this field represents the To value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingMessage_hidden_members: description: for email systems, this field represents the BCC value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingMessage_mentioned_members: description: for email systems, this field represents the CC value items: $ref: '#/components/schemas/MessagingMember' type: array property_MessagingMessage_reactions: items: $ref: '#/components/schemas/MessagingReaction' type: array property_MessagingReaction_member: properties: email: type: string image_url: type: string name: type: string user_id: type: string type: object property_MetadataMetadata_objects: additionalProperties: true type: object property_MetadataMetadata_options: items: type: string type: array property_PaymentLink_lineitems: items: $ref: '#/components/schemas/PaymentLineitem' type: array property_PaymentSubscription_lineitems: items: $ref: '#/components/schemas/PaymentLineitem' type: array property_RepoOrganization_user_ids: description: id values of the users/employees associated with this organization items: type: string type: array property_RepoPullrequest_commit_ids: items: type: string type: array property_RepoPullrequest_labels: items: type: string type: array property_RepoPullrequest_user_ids: items: type: string type: array property_ScimGroup_members: description: An array of members items: $ref: '#/components/schemas/ScimGroupMember' type: array property_ScimGroup_meta: properties: created: type: string lastModified: type: string location: type: string resourceType: enum: - User - Group type: string x-speakeasy-unknown-values: allow version: type: string type: object property_ScimGroup_schemas: description: Array of schema URIs items: enum: - urn:ietf:params:scim:schemas:core:2.0:Group type: string x-speakeasy-unknown-values: allow type: array property_ScimUser_addresses: items: $ref: '#/components/schemas/ScimAddress' type: array property_ScimUser_emails: items: $ref: '#/components/schemas/ScimEmail' type: array property_ScimUser_entitlements: items: $ref: '#/components/schemas/ScimEntitlement' type: array property_ScimUser_groups: items: $ref: '#/components/schemas/ScimUserGroups' type: array property_ScimUser_ims: items: $ref: '#/components/schemas/ScimIms' type: array property_ScimUser_meta: properties: created: type: string lastModified: type: string location: type: string resourceType: enum: - User - Group type: string x-speakeasy-unknown-values: allow version: type: string type: object property_ScimUser_name: properties: familyName: type: string formatted: type: string givenName: type: string honorificPrefix: type: string honorificSuffix: type: string middleName: type: string type: object property_ScimUser_phoneNumbers: items: $ref: '#/components/schemas/ScimPhoneNumber' type: array property_ScimUser_photos: items: $ref: '#/components/schemas/ScimPhoto' type: array property_ScimUser_roles: description: Student, Faculty, ... items: $ref: '#/components/schemas/ScimRole' type: array property_ScimUser_schemas: items: enum: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User - urn:ietf:params:scim:schemas:extension:peakon:2.0:User type: string x-speakeasy-unknown-values: allow type: array property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User: description: an organization. properties: additionalManagers: $ref: '#/components/schemas/property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_additionalManagers' birthday: format: date-time type: string costCenter: type: string currency: type: string department: type: string division: type: string employeeNumber: type: string endDate: format: date-time type: string gender: enum: - male - female type: string x-speakeasy-unknown-values: allow level: type: string location: type: string manager: $ref: '#/components/schemas/property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_manager' organization: type: string startDate: format: date-time type: string type: object property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_additionalManagers: items: $ref: '#/components/schemas/ScimManager' type: array property_ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_manager: description: '"id" attribute of another User.' properties: $ref: type: string displayName: type: string managerId: type: string type: enum: - direct - indirect type: string x-speakeasy-unknown-values: allow value: type: string type: object property_ScimUser_urn_ietf_params_scim_schemas_extension_lattice_attributes_1_0_User: properties: Job Level: type: string People Manager (Reviews): type: string Remote Work - Location: type: string Salary Information: type: string Sub Departments: type: string birthDate: format: date-time type: string ethnicity: enum: - Caucasian - East Asian - Middle Eastern - Black - Biracial (South Asian & Caucasian) - Filipino - South Asian - Indian - White - Asian type: string x-speakeasy-unknown-values: allow gender: enum: - male - female type: string x-speakeasy-unknown-values: allow sexualOrientation: enum: - Queer - Heterosexual - Straight type: string x-speakeasy-unknown-values: allow startDate: format: date-time type: string type: object property_ScimUser_urn_ietf_params_scim_schemas_extension_peakon_2_0_User: properties: Date of Birth: format: date-time type: string Gender: enum: - Female - Male type: string x-speakeasy-unknown-values: allow Manager: type: string Team: type: string type: object property_ScimUser_x509Certificates: items: $ref: '#/components/schemas/ScimRole' type: array property_ShippingRateRate_surcharges: description: Additional charges items: $ref: '#/components/schemas/ShippingRateSurcharge' type: array property_ShippingRate_from_address: description: Origin address properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingRate_packages: description: Multiple packages (alternative to package) items: $ref: '#/components/schemas/ShippingPackage' type: array property_ShippingRate_rates: items: $ref: '#/components/schemas/ShippingRateRate' type: array property_ShippingRate_to_address: description: Destination address properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingShipment_customs: description: Customs information properties: amount: type: number contents_type: enum: - MERCHANDISE - DOCUMENTS - GIFT - RETURNED_GOODS - SAMPLE - OTHER type: string x-speakeasy-unknown-values: allow currency: type: string description: type: string duties_paid_by: enum: - SENDER - RECIPIENT - THIRD_PARTY type: string x-speakeasy-unknown-values: allow items: $ref: '#/components/schemas/property_ShippingShipment_customs_items' non_delivery_option: enum: - RETURN - ABANDON type: string x-speakeasy-unknown-values: allow recipient_eori: type: string recipient_tax_number: type: string restrictions: $ref: '#/components/schemas/property_ShippingShipment_customs_restrictions' shipper_eori: type: string shipper_tax_number: type: string taxes_paid_by: enum: - SENDER - RECIPIENT - THIRD_PARTY type: string x-speakeasy-unknown-values: allow type: object property_ShippingShipment_customs_items: description: Customs items items: $ref: '#/components/schemas/ShippingCustomsItem' type: array property_ShippingShipment_customs_restrictions: description: Any restrictions items: type: string type: array property_ShippingShipment_from_address: description: Origin address properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingShipment_insurance: description: Insurance details properties: coverage_amount: type: number coverage_type: enum: - STANDARD - PREMIUM - CUSTOM type: string x-speakeasy-unknown-values: allow currency: type: string insurance_cost: type: number insurance_cost_currency: type: string insurance_provider: type: string insurance_provider_code: type: string insured_value: type: number type: object property_ShippingShipment_packages: description: Array of packages in this shipment items: $ref: '#/components/schemas/ShippingPackage' type: array property_ShippingShipment_return_address: description: Return address (may differ from from_address) properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingShipment_special_instructions: description: Array of special instructions items: type: string type: array property_ShippingShipment_to_address: description: Destination address properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingTrackingEvent_location_address: properties: address1: type: string address2: type: string city: type: string company_name: type: string country: type: string country_code: type: string delivery_instructions: type: string email: type: string is_residential: type: boolean is_validated: type: boolean name: type: string postal_code: type: string region: type: string region_code: type: string telephone: type: string type: object property_ShippingTracking_events: description: Array of tracking events items: $ref: '#/components/schemas/ShippingTrackingEvent' type: array property_StorageFile_permissions: items: $ref: '#/components/schemas/StoragePermission' type: array property_StorageFile_references: items: $ref: '#/components/schemas/StorageReference' type: array property_StoragePermission_roles: items: enum: - OWNER - READ - WRITE type: string x-speakeasy-unknown-values: allow type: array property_TaskChange_items: items: $ref: '#/components/schemas/TaskChangeItem' type: array property_TaskProject_group_ids: items: type: string type: array property_TaskProject_metadata: items: $ref: '#/components/schemas/TaskMetadata' type: array property_TaskProject_user_ids: items: type: string type: array property_TaskTask_assigned_user_ids: items: type: string type: array property_TaskTask_attachment_ids: description: Array of attachment IDs retrieved from StorageFile.Get endpoint items: type: string type: array property_TaskTask_follower_user_ids: items: type: string type: array property_TaskTask_group_ids: items: type: string type: array property_TaskTask_metadata: items: $ref: '#/components/schemas/TaskMetadata' type: array property_TaskTask_tags: items: type: string type: array property_TicketingCustomer_emails: items: $ref: '#/components/schemas/TicketingEmail' type: array property_TicketingCustomer_tags: items: type: string type: array property_TicketingCustomer_telephones: items: $ref: '#/components/schemas/TicketingTelephone' type: array property_TicketingTicket_tags: items: type: string type: array property_UcCall_contacts: items: $ref: '#/components/schemas/UcContact' type: array property_UcCall_telephone: description: The telephone number called properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object property_UcContact_emails: description: An array of email addresses for this contact items: $ref: '#/components/schemas/UcEmail' type: array property_UcContact_telephones: description: An array of telephones for this contact items: $ref: '#/components/schemas/UcTelephone' type: array property_UcRecordingMedia_transcripts: items: $ref: '#/components/schemas/UcRecordingTranscript' type: array property_UcRecording_media: items: $ref: '#/components/schemas/UcRecordingMedia' type: array property_VerificationPackage_aliases: items: type: string type: array property_VerificationPackage_average_processing_times: description: average processing time in minutes items: $ref: '#/components/schemas/VerificationTime' type: array property_VerificationPackage_parameters: description: Questions that need to be answered for this verification items: $ref: '#/components/schemas/VerificationParameter' type: array property_VerificationPackage_tags: description: Category (Verification, Validation, Background Check) items: type: string type: array property_VerificationPackage_valid_regions: description: '{country}-{state/province/territory} or just {country} 2-digit ISO codes' items: type: string type: array property_VerificationParameterInput_inputs: items: type: string type: array property_VerificationParameter_file_types: description: valid file mime types items: type: string type: array property_VerificationParameter_options: description: options for MULTIPLE_CHOICE and MULTIPLE_SELECT items: type: string type: array property_VerificationParameter_valid_regions: description: '{country}-{stateprovince/territory} or just {country} 2-digit ISO codes' items: type: string type: array property_VerificationRequest_parameters: items: $ref: '#/components/schemas/VerificationParameterInput' type: array property_VerificationRequest_profile_addresses: items: $ref: '#/components/schemas/VerificationAddress' type: array property_VerificationRequest_profile_emails: items: type: string type: array property_VerificationRequest_profile_telephones: items: type: string type: array property_VerificationRequest_response_details: items: $ref: '#/components/schemas/VerificationResponseDetail' type: array property_VerificationRequest_response_download_urls: description: report download items: type: string type: array property_VerificationTime_valid_regions: description: '{country}-{stateprovince/territory} or just {country} 2-digit ISO codes' items: type: string type: array property_Webhook_filters: additionalProperties: type: string type: object property_Webhook_runs: description: An array of the most revent virtual webhook runs items: type: string type: array securitySchemes: jwt: in: header name: authorization type: apiKey externalDocs: description: API Documentation url: https://docs.unified.to info: contact: email: hello@unified.to url: https://unified.to/contact description: One API to Rule Them All termsOfService: https://unified.to/tos title: Unified.to API version: '1.0' openapi: 3.0.0 paths: /assessment/{connection_id}/order/{id}: patch: operationId: patchAssessmentOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - workspace_id - connection_id - webhook_id - package_id - parameters - target_url - status - reference - application_id - job_id - company_id - candidate_id - employee_id - profile_name - profile_first_name - profile_last_name - profile_resume_url - profile_ip_address - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - profile_social_media_urls - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_max_score - response_url - response_redirect_url - response_download_urls - response_details - response_source - response_attributes - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentOrder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentOrder' description: Successful security: - jwt: [] summary: Update an order tags: - assessment - order put: operationId: updateAssessmentOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - workspace_id - connection_id - webhook_id - package_id - parameters - target_url - status - reference - application_id - job_id - company_id - candidate_id - employee_id - profile_name - profile_first_name - profile_last_name - profile_resume_url - profile_ip_address - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - profile_social_media_urls - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_max_score - response_url - response_redirect_url - response_download_urls - response_details - response_source - response_attributes - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentOrder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentOrder' description: Successful security: - jwt: [] summary: Update an order tags: - assessment - order /assessment/{connection_id}/package: get: operationId: listAssessmentPackages parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentPackages' description: Successful security: - jwt: [] summary: List assessment packages tags: - assessment - package post: operationId: createAssessmentPackage parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Used by assessment providers to SUBMIT packages to ATS systems required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Successful security: - jwt: [] summary: Create an assessment package tags: - assessment - package /assessment/{connection_id}/package/{id}: delete: operationId: removeAssessmentPackage parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Package in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Delete an assessment package tags: - assessment - package get: operationId: getAssessmentPackage parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Package in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Successful security: - jwt: [] summary: Get an assessment package tags: - assessment - package patch: operationId: patchAssessmentPackage parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Package in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Used by assessment providers to SUBMIT packages to ATS systems required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Successful security: - jwt: [] summary: Update an assessment package tags: - assessment - package put: operationId: updateAssessmentPackage parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Package in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Used by assessment providers to SUBMIT packages to ATS systems required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssessmentPackage' description: Successful security: - jwt: [] summary: Update an assessment package tags: - assessment - package /lms/{connection_id}/activity: get: operationId: listLmsActivities parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The content ID to filter by in: query name: content_id required: false schema: type: string - description: The student ID to filter by (reference to LmsStudent) in: query name: student_id required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - content_id - course_id - student_id - duration_minutes - assigned_grade - is_completed - progress_percentage - started_at - completed_at - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsActivities' description: Successful security: - jwt: [] summary: List all activities tags: - lms - activity post: operationId: createLmsActivity parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - content_id - course_id - student_id - duration_minutes - assigned_grade - is_completed - progress_percentage - started_at - completed_at - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsActivity' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsActivity' description: Successful security: - jwt: [] summary: Create an activity tags: - lms - activity /lms/{connection_id}/activity/{id}: delete: operationId: removeLmsActivity parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Activity in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an activity tags: - lms - activity get: operationId: getLmsActivity parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - content_id - course_id - student_id - duration_minutes - assigned_grade - is_completed - progress_percentage - started_at - completed_at - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Activity in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsActivity' description: Successful security: - jwt: [] summary: Retrieve an activity tags: - lms - activity patch: operationId: patchLmsActivity parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - content_id - course_id - student_id - duration_minutes - assigned_grade - is_completed - progress_percentage - started_at - completed_at - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Activity in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsActivity' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsActivity' description: Successful security: - jwt: [] summary: Update an activity tags: - lms - activity put: operationId: updateLmsActivity parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - content_id - course_id - student_id - duration_minutes - assigned_grade - is_completed - progress_percentage - started_at - completed_at - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Activity in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsActivity' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsActivity' description: Successful security: - jwt: [] summary: Update an activity tags: - lms - activity /lms/{connection_id}/class: get: operationId: listLmsClasses parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - course_id - instructor_ids - student_ids - languages - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsClasses' description: Successful security: - jwt: [] summary: List all classes tags: - lms - class post: operationId: createLmsClass parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - course_id - instructor_ids - student_ids - languages - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsClass' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsClass' description: Successful security: - jwt: [] summary: Create a class tags: - lms - class /lms/{connection_id}/class/{id}: delete: operationId: removeLmsClass parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Class in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a class tags: - lms - class get: operationId: getLmsClass parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - course_id - instructor_ids - student_ids - languages - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Class in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsClass' description: Successful security: - jwt: [] summary: Retrieve a class tags: - lms - class patch: operationId: patchLmsClass parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - course_id - instructor_ids - student_ids - languages - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Class in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsClass' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsClass' description: Successful security: - jwt: [] summary: Update a class tags: - lms - class put: operationId: updateLmsClass parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - course_id - instructor_ids - student_ids - languages - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Class in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsClass' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsClass' description: Successful security: - jwt: [] summary: Update a class tags: - lms - class /lms/{connection_id}/collection: get: operationId: listLmsCollections parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: The parent ID to filter by in: query name: parent_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - is_active - parent_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCollections' description: Successful security: - jwt: [] summary: List all collections tags: - lms - collection post: operationId: createLmsCollection parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCollection' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCollection' description: Successful security: - jwt: [] summary: Create a collection tags: - lms - collection /lms/{connection_id}/collection/{id}: delete: operationId: removeLmsCollection parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Collection in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a collection tags: - lms - collection get: operationId: getLmsCollection parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Collection in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCollection' description: Successful security: - jwt: [] summary: Retrieve a collection tags: - lms - collection patch: operationId: patchLmsCollection parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Collection in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCollection' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCollection' description: Successful security: - jwt: [] summary: Update a collection tags: - lms - collection put: operationId: updateLmsCollection parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - media - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Collection in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCollection' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCollection' description: Successful security: - jwt: [] summary: Update a collection tags: - lms - collection /lms/{connection_id}/content: get: operationId: listLmsContents parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: The collection ID to filter by (reference to CommerceCollection) in: query name: collection_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - external_reference - course_ids - name - description - languages - media - is_active - duration_minutes - categories - skills - sort_order - provider_name - short_description - localizations - instructor_ids - collection_ids - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsContents' description: Successful security: - jwt: [] summary: List all contents tags: - lms - content post: operationId: createLmsContent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - external_reference - course_ids - name - description - languages - media - is_active - duration_minutes - categories - skills - sort_order - provider_name - short_description - localizations - instructor_ids - collection_ids - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsContent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsContent' description: Successful security: - jwt: [] summary: Create a content tags: - lms - content /lms/{connection_id}/content/{id}: delete: operationId: removeLmsContent parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Content in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a content tags: - lms - content get: operationId: getLmsContent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - external_reference - course_ids - name - description - languages - media - is_active - duration_minutes - categories - skills - sort_order - provider_name - short_description - localizations - instructor_ids - collection_ids - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Content in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsContent' description: Successful security: - jwt: [] summary: Retrieve a content tags: - lms - content patch: operationId: patchLmsContent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - external_reference - course_ids - name - description - languages - media - is_active - duration_minutes - categories - skills - sort_order - provider_name - short_description - localizations - instructor_ids - collection_ids - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Content in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsContent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsContent' description: Successful security: - jwt: [] summary: Update a content tags: - lms - content put: operationId: updateLmsContent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - external_reference - course_ids - name - description - languages - media - is_active - duration_minutes - categories - skills - sort_order - provider_name - short_description - localizations - instructor_ids - collection_ids - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Content in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsContent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsContent' description: Successful security: - jwt: [] summary: Update a content tags: - lms - content /lms/{connection_id}/course: get: operationId: listLmsCourses parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The class ID to filter by (reference to LmsClass) in: query name: class_id required: false schema: type: string - description: The company ID to filter by (reference to HrisCompany) in: query name: company_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_private - is_active - price_amount - languages - categories - currency - media - instructor_ids - instructors - student_ids - students - content_ids - skills - duration_minutes - provider_name - raw - published_at - time_estimate_minutes type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCourses' description: Successful security: - jwt: [] summary: List all courses tags: - lms - course post: operationId: createLmsCourse parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_private - is_active - price_amount - languages - categories - currency - media - instructor_ids - instructors - student_ids - students - content_ids - skills - duration_minutes - provider_name - raw - published_at - time_estimate_minutes type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCourse' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCourse' description: Successful security: - jwt: [] summary: Create a course tags: - lms - course /lms/{connection_id}/course/{id}: delete: operationId: removeLmsCourse parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Course in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a course tags: - lms - course get: operationId: getLmsCourse parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_private - is_active - price_amount - languages - categories - currency - media - instructor_ids - instructors - student_ids - students - content_ids - skills - duration_minutes - provider_name - raw - published_at - time_estimate_minutes type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Course in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCourse' description: Successful security: - jwt: [] summary: Retrieve a course tags: - lms - course patch: operationId: patchLmsCourse parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_private - is_active - price_amount - languages - categories - currency - media - instructor_ids - instructors - student_ids - students - content_ids - skills - duration_minutes - provider_name - raw - published_at - time_estimate_minutes type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Course in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCourse' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCourse' description: Successful security: - jwt: [] summary: Update a course tags: - lms - course put: operationId: updateLmsCourse parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_private - is_active - price_amount - languages - categories - currency - media - instructor_ids - instructors - student_ids - students - content_ids - skills - duration_minutes - provider_name - raw - published_at - time_estimate_minutes type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Course in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsCourse' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsCourse' description: Successful security: - jwt: [] summary: Update a course tags: - lms - course /lms/{connection_id}/instructor: get: operationId: listLmsInstructors parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The class ID to filter by (reference to LmsClass) in: query name: class_id required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: The company ID to filter by (reference to HrisCompany) in: query name: company_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - title - telephones - image_url - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsInstructors' description: Successful security: - jwt: [] summary: List all instructors tags: - lms - instructor post: operationId: createLmsInstructor parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - title - telephones - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' description: Successful security: - jwt: [] summary: Create an instructor tags: - lms - instructor /lms/{connection_id}/instructor/{id}: delete: operationId: removeLmsInstructor parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Instructor in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an instructor tags: - lms - instructor get: operationId: getLmsInstructor parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - title - telephones - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Instructor in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' description: Successful security: - jwt: [] summary: Retrieve an instructor tags: - lms - instructor patch: operationId: patchLmsInstructor parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - title - telephones - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Instructor in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' description: Successful security: - jwt: [] summary: Update an instructor tags: - lms - instructor put: operationId: updateLmsInstructor parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - title - telephones - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Instructor in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsInstructor' description: Successful security: - jwt: [] summary: Update an instructor tags: - lms - instructor /lms/{connection_id}/student: get: operationId: listLmsStudents parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The class ID to filter by (reference to LmsClass) in: query name: class_id required: false schema: type: string - description: The course ID to filter by (reference to Course) in: query name: course_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - address - image_url - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsStudents' description: Successful security: - jwt: [] summary: List all students tags: - lms - student post: operationId: createLmsStudent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - address - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsStudent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsStudent' description: Successful security: - jwt: [] summary: Create a student tags: - lms - student /lms/{connection_id}/student/{id}: delete: operationId: removeLmsStudent parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Student in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a student tags: - lms - student get: operationId: getLmsStudent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - address - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Student in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsStudent' description: Successful security: - jwt: [] summary: Retrieve a student tags: - lms - student patch: operationId: patchLmsStudent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - address - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Student in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsStudent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsStudent' description: Successful security: - jwt: [] summary: Update a student tags: - lms - student put: operationId: updateLmsStudent parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - address - image_url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Student in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LmsStudent' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LmsStudent' description: Successful security: - jwt: [] summary: Update a student tags: - lms - student /verification/{connection_id}/package: get: operationId: listVerificationPackages parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - type - aliases - tags - description - parameters - average_processing_times - has_redirect_url - has_target_url - needs_ip_address - cost_amount - currency - max_score - info_url - valid_regions - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationPackages' description: Successful security: - jwt: [] summary: List all packages tags: - verification - package /verification/{connection_id}/package/{id}: get: operationId: getVerificationPackage parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - type - aliases - tags - description - parameters - average_processing_times - has_redirect_url - has_target_url - needs_ip_address - cost_amount - currency - max_score - info_url - valid_regions - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Package in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationPackage' description: Successful security: - jwt: [] summary: Retrieve a package tags: - verification - package /verification/{connection_id}/request: get: operationId: listVerificationRequests parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The package ID to filter by in: query name: package_id required: false schema: type: string - description: The candidate ID to filter by in: query name: candidate_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - package_id - parameters - target_url - candidate_id - profile_ip_address - profile_name - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_redirect_url - response_download_urls - response_details - response_source - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequests' description: Successful security: - jwt: [] summary: List all requests tags: - verification - request post: operationId: createVerificationRequest parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - package_id - parameters - target_url - candidate_id - profile_ip_address - profile_name - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_redirect_url - response_download_urls - response_details - response_source - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' description: Successful security: - jwt: [] summary: Create a request tags: - verification - request /verification/{connection_id}/request/{id}: delete: operationId: removeVerificationRequest parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Request in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a request tags: - verification - request get: operationId: getVerificationRequest parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - package_id - parameters - target_url - candidate_id - profile_ip_address - profile_name - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_redirect_url - response_download_urls - response_details - response_source - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Request in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' description: Successful security: - jwt: [] summary: Retrieve a request tags: - verification - request patch: operationId: patchVerificationRequest parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - package_id - parameters - target_url - candidate_id - profile_ip_address - profile_name - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_redirect_url - response_download_urls - response_details - response_source - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Request in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' description: Successful security: - jwt: [] summary: Update a request tags: - verification - request put: operationId: updateVerificationRequest parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - package_id - parameters - target_url - candidate_id - profile_ip_address - profile_name - profile_date_of_birth - profile_addresses - profile_gender - profile_emails - profile_telephones - profile_national_identifier - response_completed_at - response_expires_at - response_issued_at - response_status - response_score - response_redirect_url - response_download_urls - response_details - response_source - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Request in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequest' description: Successful security: - jwt: [] summary: Update a request tags: - verification - request security: - jwt: [] servers: - description: North American data region url: https://api.unified.to - description: European data region url: https://api-eu.unified.to - description: Australian data region url: https://api-au.unified.to tags: - description: Unified.to API name: unifiedapi - name: unified - name: connection - name: issue - name: integration - name: webhook - name: apicall - name: environment - name: auth - name: login - name: assessment - name: package - name: order - name: messaging - name: channel - name: message - name: event - name: crm - name: deal - name: contact - name: company - name: lead - name: pipeline - name: martech - name: list - name: member - name: campaign - name: report - name: ticketing - name: ticket - name: customer - name: note - name: category - name: enrich - name: person - name: uc - name: call - name: comment - name: recording - name: ats - name: activity - name: candidate - name: job - name: interview - name: document - name: applicationstatus - name: application - name: scorecard - name: hris - name: employee - name: location - name: group - name: timeoff - name: payslip - name: device - name: timeshift - name: benefit - name: deduction - name: bankaccount - name: verification - name: request - name: passthrough - name: accounting - name: account - name: journal - name: transaction - name: invoice - name: bill - name: creditmemo - name: taxrate - name: organization - name: purchaseorder - name: salesorder - name: balancesheet - name: trialbalance - name: profitloss - name: cashflow - name: expense - name: storage - name: file - name: commerce - name: item - name: collection - name: inventory - name: review - name: reservation - name: availability - name: saleschannel - name: itemvariant - name: payment - name: link - name: refund - name: payout - name: subscription - name: genai - name: model - name: prompt - name: embedding - name: kms - name: space - name: page - name: task - name: project - name: change - name: calendar - name: busy - name: webinar - name: ads - name: creative - name: insertionorder - name: ad - name: target - name: promoted - name: lms - name: course - name: class - name: student - name: instructor - name: content - name: repo - name: repository - name: branch - name: commit - name: pullrequest - name: metadata - name: forms - name: form - name: submission - name: shipping - name: shipment - name: label - name: tracking - name: rate - name: carrier - name: signing - name: signatory - name: template - name: scim - name: user