diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 721fcc2b..12e5aa02 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: fca0ac3a-5f4e-452c-bbc7-2311afa8da40 management: - docChecksum: 40c50bc2ce3ca5912ca947f385f67f6c + docChecksum: e48a35a03464d13fe7097cbee9013a9a docVersion: 10.10.0 - speakeasyVersion: 1.469.11 - generationVersion: 2.493.32 - releaseVersion: 0.4.0 - configChecksum: 9046e3ea37f799ccb0f666279a666d68 + speakeasyVersion: 1.469.12 + generationVersion: 2.493.34 + releaseVersion: 0.5.0 + configChecksum: 69751c5b1bce0ec648491e77fadaafbd repoURL: https://github.com/apideck-libraries/sdk-python.git installationURL: https://github.com/apideck-libraries/sdk-python.git published: true @@ -32,7 +32,6 @@ features: globalServerURLs: 3.1.0 globals: 3.0.0 groups: 3.0.0 - hiddenGlobals: 1.0.0 inputOutputModels: 3.0.0 methodArguments: 1.0.2 methodServerURLs: 3.1.1 @@ -1509,6 +1508,7 @@ generatedFiles: - docs/models/vaultconsumerrequestcountsallrequest.md - docs/models/vaultconsumerrequestcountsallresponse.md - docs/models/vaultconsumersaddglobals.md + - docs/models/vaultconsumersaddrequest.md - docs/models/vaultconsumersaddresponse.md - docs/models/vaultconsumersallglobals.md - docs/models/vaultconsumersallrequest.md @@ -1535,6 +1535,7 @@ generatedFiles: - docs/models/vaultlogsallrequest.md - docs/models/vaultlogsallresponse.md - docs/models/vaultsessionscreateglobals.md + - docs/models/vaultsessionscreaterequest.md - docs/models/vaultsessionscreateresponse.md - docs/models/vaultvalidateconnectionstateglobals.md - docs/models/vaultvalidateconnectionstaterequest.md @@ -1555,6 +1556,7 @@ generatedFiles: - docs/models/webhooksupport.md - docs/models/webhooksupportresources.md - docs/models/webhookwebhooksaddglobals.md + - docs/models/webhookwebhooksaddrequest.md - docs/models/webhookwebhooksaddresponse.md - docs/models/webhookwebhooksallglobals.md - docs/models/webhookwebhooksallrequest.md @@ -2640,7 +2642,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"id": "1234", "name": "GST on Purchases", "code": "ABN", "description": "Reduced rate GST Purchases", "effective_tax_rate": 10, "total_tax_rate": 10, "tax_payable_account_id": "123456", "tax_remitted_account_id": "123456", "components": [{"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}], "type": "NONE", "report_tax_type": "NONE", "original_tax_rate_id": "12345", "status": "active", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}]} + application/json: {"id": "1234", "name": "GST on Purchases", "code": "ABN", "description": "Reduced rate GST Purchases", "effective_tax_rate": 10, "total_tax_rate": 10, "tax_payable_account_id": "123456", "tax_remitted_account_id": "123456", "components": [{"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}, {"id": "10", "name": "GST", "rate": 10, "compound": true}], "type": "NONE", "report_tax_type": "NONE", "original_tax_rate_id": "12345", "status": "active", "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "tax-rates", "operation": "update", "data": {"id": "12345"}} @@ -2776,7 +2778,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} + application/json: {"bill_number": "10001", "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "bill_date": "2020-09-30", "due_date": "2020-10-30", "paid_date": "2020-10-30", "po_number": "90000117", "reference": "123456", "line_items": [{"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}, {"row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "expense_account", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345"}], "terms": "Net 30 days", "balance": 27500, "deposit": 0, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_code": "1234", "notes": "Some notes about this bill.", "status": "draft", "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "discount_percentage": 5.5, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "accounting_period": "01-24"} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "bills", "operation": "update", "data": {"id": "12345"}} @@ -2834,7 +2836,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2912,7 +2914,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "update", "data": {"id": "12345", "downstream_id": "12345"}} @@ -3242,7 +3244,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "all", "data": [{"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "all", "data": [{"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}, {}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3295,7 +3297,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "one", "data": {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "one", "data": {"id": "123456", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_amount": 49.99, "total_tax": 2500, "tax_code": "1234", "balance": 27500, "remaining_credit": 27500, "status": "authorised", "reference": "123456", "date_issued": "2021-05-01T12:00:00.000Z", "date_paid": "2021-05-01T12:00:00.000Z", "type": "accounts_receivable_credit", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this credit note", "terms": "Some terms about this credit note", "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "tracking_categories": [{"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3401,7 +3403,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "customers", "operation": "add", "data": {"id": "12345"}} @@ -3456,7 +3458,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "project": false, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this customer", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "parent": {"id": "12345", "name": "Windsurf Shop"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "customers", "operation": "update", "data": {"id": "12345"}} @@ -3537,7 +3539,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "add", "data": {"id": "12345"}} @@ -3592,7 +3594,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} + application/json: {"display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", "company_id": "12345", "title": "CEO", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "suffix": "Jr.", "individual": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "notes": "Some notes about this supplier", "tax_rate": {"id": "123456", "rate": 10}, "tax_number": "US123945459", "currency": "USD", "account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "status": "active", "payment_method": "cash", "channel": "email", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}], "subsidiary_id": "12345"} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "suppliers", "operation": "update", "data": {"id": "12345"}} @@ -3942,7 +3944,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": "USD", "company_id": "12345", "line_items": [{"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}, {"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "tax_amount": 27500, "sub_total": 27500, "total_amount": 27500, "type": "debit", "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "supplier": {"id": "12345", "display_name": "Windsurf Shop", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "line_number": 1}], "memo": "Thank you for your business and have a great day!", "posted_at": "2020-09-30T07:43:32.000Z", "journal_symbol": "IND", "tax_type": "sales", "tax_code": "1234", "number": "OIT00546", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "accounting_period": "01-24", "row_version": "1-12345", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "journal-entries", "operation": "update", "data": {"id": "12345"}} @@ -4051,7 +4053,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "PurchaseOrders", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "po_number": "90000117", "reference": "123456", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "status": "open", "issued_date": "2020-09-30", "delivery_date": "2020-09-30", "expected_arrival_date": "2020-09-30", "currency": "USD", "currency_rate": 0.69, "sub_total": 27500, "total_tax": 2500, "total": 27500, "tax_inclusive": true, "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "template_id": "123456", "discount_percentage": 5.5, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "accounting_by_row": false, "due_date": "2020-10-30", "payment_method": "cash", "tax_code": "1234", "channel": "email", "memo": "Thank you for the partnership and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -4992,7 +4994,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "update", "data": {"id": "12345"}} @@ -5130,7 +5132,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5398,7 +5400,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}, {}]}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5557,7 +5559,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "add", "data": {"id": "12345"}} @@ -5613,7 +5615,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "update", "data": {"id": "12345"}} @@ -5671,7 +5673,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5830,7 +5832,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "add", "data": {"id": "12345"}} @@ -5885,7 +5887,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": [{}]}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "update", "data": {"id": "12345"}} @@ -6238,7 +6240,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -7402,7 +7404,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": [{"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "all", "data": [{"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"id": "12345", "employee_id": "12345", "title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"id": "3404301363494309004", "job_id": "3490439050957906679", "rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -7482,7 +7484,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} + application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "addresses": [{"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "update", "data": {"id": "12345"}} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 42b5b019..eff6659f 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -16,7 +16,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true python: - version: 0.4.0 + version: 0.5.0 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index e46f660b..7ffde91d 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.469.11 +speakeasyVersion: 1.469.12 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:00a0a354f17a0ea8997dba873c68faca39ec080018cef76bade86ee67ffe58d6 - sourceBlobDigest: sha256:440170e04444bbabcdba274c27423ec34165bdaf07db37271d5a69da494303e5 + sourceRevisionDigest: sha256:5cea8979d05da46121eae52e7424ec73d0cc9410385fd3cbca0bb070e116053c + sourceBlobDigest: sha256:d1bd8bb402097918477134948061c78edfeb0f07474e006b73d843502a1fb44c tags: - latest - - speakeasy-sdk-regen-1737099259 + - speakeasy-sdk-regen-1737468463 - 10.10.0 targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:00a0a354f17a0ea8997dba873c68faca39ec080018cef76bade86ee67ffe58d6 - sourceBlobDigest: sha256:440170e04444bbabcdba274c27423ec34165bdaf07db37271d5a69da494303e5 + sourceRevisionDigest: sha256:5cea8979d05da46121eae52e7424ec73d0cc9410385fd3cbca0bb070e116053c + sourceBlobDigest: sha256:d1bd8bb402097918477134948061c78edfeb0f07474e006b73d843502a1fb44c codeSamplesNamespace: apideck-python-code-samples - codeSamplesRevisionDigest: sha256:07d9ff8fed7b85504cf697c239f442bf689c8b89b701c15a8c89052714a7992e + codeSamplesRevisionDigest: sha256:ae6b7aa7fa730358da7bed2bdb25a4b0eea5e0af2f937c80fa716560fdab3fb1 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 58de8374..56e357c0 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -119,7 +119,7 @@ async def main(): app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = await apideck.accounting.tax_rates.list_async(raw=False, service_id="salesforce", limit=20, filter_={ + res = await apideck.accounting.tax_rates.list_async(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -160,7 +160,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -723,7 +723,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -758,7 +758,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -789,7 +789,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -846,7 +846,7 @@ with Apideck( res = None try: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -899,7 +899,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -929,7 +929,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.upload_sessions.create(name="Documents", parent_folder_id="1234", size=1810673, raw=False, service_id="salesforce", drive_id="1234", pass_through=[ + res = apideck.file_storage.upload_sessions.create(name="Documents", parent_folder_id="1234", size=1810673, raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", drive_id="1234", pass_through=[ { "service_id": "", "extend_paths": [ diff --git a/RELEASES.md b/RELEASES.md index 02624006..e02a494b 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -78,4 +78,14 @@ Based on: ### Generated - [python v0.4.0] . ### Releases -- [PyPI v0.4.0] https://pypi.org/project/apideck-unify/0.4.0 - . \ No newline at end of file +- [PyPI v0.4.0] https://pypi.org/project/apideck-unify/0.4.0 - . + +## 2025-01-21 14:07:26 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.469.12 (2.493.34) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.5.0] . +### Releases +- [PyPI v0.5.0] https://pypi.org/project/apideck-unify/0.5.0 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index a4317886..a9415fb3 100644 --- a/USAGE.md +++ b/USAGE.md @@ -10,7 +10,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -42,7 +42,7 @@ async def main(): app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = await apideck.accounting.tax_rates.list_async(raw=False, service_id="salesforce", limit=20, filter_={ + res = await apideck.accounting.tax_rates.list_async(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, diff --git a/docs/models/accountingageddebtorsonerequest.md b/docs/models/accountingageddebtorsonerequest.md index 0cd0e86e..c503eefb 100644 --- a/docs/models/accountingageddebtorsonerequest.md +++ b/docs/models/accountingageddebtorsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.AgedReportFilter]](../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"supplier_id": "123abc",
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/accountingattachmentsallrequest.md b/docs/models/accountingattachmentsallrequest.md index f5dd5b07..107b8b31 100644 --- a/docs/models/accountingattachmentsallrequest.md +++ b/docs/models/accountingattachmentsallrequest.md @@ -8,6 +8,8 @@ | `reference_type` | [models.AttachmentReferenceType](../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingattachmentsdeleterequest.md b/docs/models/accountingattachmentsdeleterequest.md index fd97d0bd..723e9211 100644 --- a/docs/models/accountingattachmentsdeleterequest.md +++ b/docs/models/accountingattachmentsdeleterequest.md @@ -8,5 +8,7 @@ | `reference_type` | [models.AttachmentReferenceType](../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingattachmentsdownloadrequest.md b/docs/models/accountingattachmentsdownloadrequest.md index aa3fe928..fe1b8ca2 100644 --- a/docs/models/accountingattachmentsdownloadrequest.md +++ b/docs/models/accountingattachmentsdownloadrequest.md @@ -8,5 +8,7 @@ | `reference_type` | [models.AttachmentReferenceType](../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingattachmentsonerequest.md b/docs/models/accountingattachmentsonerequest.md index 671615a0..bcae573c 100644 --- a/docs/models/accountingattachmentsonerequest.md +++ b/docs/models/accountingattachmentsonerequest.md @@ -8,6 +8,8 @@ | `reference_type` | [models.AttachmentReferenceType](../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingbalancesheetonerequest.md b/docs/models/accountingbalancesheetonerequest.md index d51e7a9f..4fb71c2d 100644 --- a/docs/models/accountingbalancesheetonerequest.md +++ b/docs/models/accountingbalancesheetonerequest.md @@ -5,6 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `filter_` | [Optional[models.BalanceSheetFilter]](../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month"
} | diff --git a/docs/models/accountingbillpaymentsaddrequest.md b/docs/models/accountingbillpaymentsaddrequest.md index 1c403429..f89793bf 100644 --- a/docs/models/accountingbillpaymentsaddrequest.md +++ b/docs/models/accountingbillpaymentsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingbillpaymentsallrequest.md b/docs/models/accountingbillpaymentsallrequest.md index 6b6fe4de..76e9730b 100644 --- a/docs/models/accountingbillpaymentsallrequest.md +++ b/docs/models/accountingbillpaymentsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingbillpaymentsdeleterequest.md b/docs/models/accountingbillpaymentsdeleterequest.md index 3c636d03..5eb2e1b2 100644 --- a/docs/models/accountingbillpaymentsdeleterequest.md +++ b/docs/models/accountingbillpaymentsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingbillpaymentsonerequest.md b/docs/models/accountingbillpaymentsonerequest.md index 5d6ec19a..571766e9 100644 --- a/docs/models/accountingbillpaymentsonerequest.md +++ b/docs/models/accountingbillpaymentsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingbillpaymentsupdaterequest.md b/docs/models/accountingbillpaymentsupdaterequest.md index 3434b972..bc7790de 100644 --- a/docs/models/accountingbillpaymentsupdaterequest.md +++ b/docs/models/accountingbillpaymentsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `bill_payment` | [models.BillPaymentInput](../models/billpaymentinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingbillsaddrequest.md b/docs/models/accountingbillsaddrequest.md index dea757f7..5677daab 100644 --- a/docs/models/accountingbillsaddrequest.md +++ b/docs/models/accountingbillsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingbillsallrequest.md b/docs/models/accountingbillsallrequest.md index feade680..90698744 100644 --- a/docs/models/accountingbillsallrequest.md +++ b/docs/models/accountingbillsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingbillsdeleterequest.md b/docs/models/accountingbillsdeleterequest.md index b1efc63f..426dea5f 100644 --- a/docs/models/accountingbillsdeleterequest.md +++ b/docs/models/accountingbillsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingbillsonerequest.md b/docs/models/accountingbillsonerequest.md index 35602c21..7191836a 100644 --- a/docs/models/accountingbillsonerequest.md +++ b/docs/models/accountingbillsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingbillsupdaterequest.md b/docs/models/accountingbillsupdaterequest.md index 0c0d9408..f26dc295 100644 --- a/docs/models/accountingbillsupdaterequest.md +++ b/docs/models/accountingbillsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `bill` | [models.BillInput](../models/billinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingcompanyinfoonerequest.md b/docs/models/accountingcompanyinfoonerequest.md index 9227bc63..6743b614 100644 --- a/docs/models/accountingcompanyinfoonerequest.md +++ b/docs/models/accountingcompanyinfoonerequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesaddrequest.md b/docs/models/accountingcreditnotesaddrequest.md index 0b00c5fe..cda2b4ca 100644 --- a/docs/models/accountingcreditnotesaddrequest.md +++ b/docs/models/accountingcreditnotesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesallrequest.md b/docs/models/accountingcreditnotesallrequest.md index 843fca30..f5d15f9a 100644 --- a/docs/models/accountingcreditnotesallrequest.md +++ b/docs/models/accountingcreditnotesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingcreditnotesdeleterequest.md b/docs/models/accountingcreditnotesdeleterequest.md index 644eaf54..5d9ef113 100644 --- a/docs/models/accountingcreditnotesdeleterequest.md +++ b/docs/models/accountingcreditnotesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesonerequest.md b/docs/models/accountingcreditnotesonerequest.md index 112de48c..27bb0aa0 100644 --- a/docs/models/accountingcreditnotesonerequest.md +++ b/docs/models/accountingcreditnotesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingcreditnotesupdaterequest.md b/docs/models/accountingcreditnotesupdaterequest.md index f09eef31..92ce55dc 100644 --- a/docs/models/accountingcreditnotesupdaterequest.md +++ b/docs/models/accountingcreditnotesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `credit_note` | [models.CreditNoteInput](../models/creditnoteinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingcustomersaddrequest.md b/docs/models/accountingcustomersaddrequest.md index 15550b28..6721273a 100644 --- a/docs/models/accountingcustomersaddrequest.md +++ b/docs/models/accountingcustomersaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingcustomersallrequest.md b/docs/models/accountingcustomersallrequest.md index dff04c46..23969575 100644 --- a/docs/models/accountingcustomersallrequest.md +++ b/docs/models/accountingcustomersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingcustomersdeleterequest.md b/docs/models/accountingcustomersdeleterequest.md index 66b035f5..210de70b 100644 --- a/docs/models/accountingcustomersdeleterequest.md +++ b/docs/models/accountingcustomersdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingcustomersonerequest.md b/docs/models/accountingcustomersonerequest.md index 6dd6c829..9548a891 100644 --- a/docs/models/accountingcustomersonerequest.md +++ b/docs/models/accountingcustomersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingcustomersupdaterequest.md b/docs/models/accountingcustomersupdaterequest.md index fdd642f9..5b64e17a 100644 --- a/docs/models/accountingcustomersupdaterequest.md +++ b/docs/models/accountingcustomersupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `customer` | [models.CustomerInput](../models/customerinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsaddrequest.md b/docs/models/accountingdepartmentsaddrequest.md index f8e52aa6..91b7dc5d 100644 --- a/docs/models/accountingdepartmentsaddrequest.md +++ b/docs/models/accountingdepartmentsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsallrequest.md b/docs/models/accountingdepartmentsallrequest.md index 67bd4890..f529ea23 100644 --- a/docs/models/accountingdepartmentsallrequest.md +++ b/docs/models/accountingdepartmentsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingdepartmentsdeleterequest.md b/docs/models/accountingdepartmentsdeleterequest.md index 713dc2ea..ae522634 100644 --- a/docs/models/accountingdepartmentsdeleterequest.md +++ b/docs/models/accountingdepartmentsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsonerequest.md b/docs/models/accountingdepartmentsonerequest.md index c3ab7b74..26d45db5 100644 --- a/docs/models/accountingdepartmentsonerequest.md +++ b/docs/models/accountingdepartmentsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingdepartmentsupdaterequest.md b/docs/models/accountingdepartmentsupdaterequest.md index a4e15574..8462bfa4 100644 --- a/docs/models/accountingdepartmentsupdaterequest.md +++ b/docs/models/accountingdepartmentsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `accounting_department` | [models.AccountingDepartmentInput](../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingexpensesaddrequest.md b/docs/models/accountingexpensesaddrequest.md index 2bf5412f..5617eb04 100644 --- a/docs/models/accountingexpensesaddrequest.md +++ b/docs/models/accountingexpensesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingexpensesallrequest.md b/docs/models/accountingexpensesallrequest.md index bb823a2e..3df25d38 100644 --- a/docs/models/accountingexpensesallrequest.md +++ b/docs/models/accountingexpensesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | \ No newline at end of file diff --git a/docs/models/accountingexpensesdeleterequest.md b/docs/models/accountingexpensesdeleterequest.md index cbccfcc1..75b1748d 100644 --- a/docs/models/accountingexpensesdeleterequest.md +++ b/docs/models/accountingexpensesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingexpensesonerequest.md b/docs/models/accountingexpensesonerequest.md index 2abc0e6d..3ceb168c 100644 --- a/docs/models/accountingexpensesonerequest.md +++ b/docs/models/accountingexpensesonerequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingexpensesupdaterequest.md b/docs/models/accountingexpensesupdaterequest.md index 3ced1f89..d66ba602 100644 --- a/docs/models/accountingexpensesupdaterequest.md +++ b/docs/models/accountingexpensesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `expense` | [models.ExpenseInput](../models/expenseinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinginvoiceitemsaddrequest.md b/docs/models/accountinginvoiceitemsaddrequest.md index b05648c8..215f7089 100644 --- a/docs/models/accountinginvoiceitemsaddrequest.md +++ b/docs/models/accountinginvoiceitemsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountinginvoiceitemsallrequest.md b/docs/models/accountinginvoiceitemsallrequest.md index bc7cd254..3bd92d0d 100644 --- a/docs/models/accountinginvoiceitemsallrequest.md +++ b/docs/models/accountinginvoiceitemsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountinginvoiceitemsdeleterequest.md b/docs/models/accountinginvoiceitemsdeleterequest.md index ac4932fe..ea75b50c 100644 --- a/docs/models/accountinginvoiceitemsdeleterequest.md +++ b/docs/models/accountinginvoiceitemsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinginvoiceitemsonerequest.md b/docs/models/accountinginvoiceitemsonerequest.md index b93a8fc9..9d5f4b33 100644 --- a/docs/models/accountinginvoiceitemsonerequest.md +++ b/docs/models/accountinginvoiceitemsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/models/accountinginvoiceitemsupdaterequest.md b/docs/models/accountinginvoiceitemsupdaterequest.md index 037cd26d..47da9323 100644 --- a/docs/models/accountinginvoiceitemsupdaterequest.md +++ b/docs/models/accountinginvoiceitemsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `invoice_item` | [models.InvoiceItemInput](../models/invoiceiteminput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinginvoicesaddrequest.md b/docs/models/accountinginvoicesaddrequest.md index a0fea9e1..3e720c8b 100644 --- a/docs/models/accountinginvoicesaddrequest.md +++ b/docs/models/accountinginvoicesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountinginvoicesallrequest.md b/docs/models/accountinginvoicesallrequest.md index a2a43611..b3ab64d6 100644 --- a/docs/models/accountinginvoicesallrequest.md +++ b/docs/models/accountinginvoicesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountinginvoicesdeleterequest.md b/docs/models/accountinginvoicesdeleterequest.md index 31db5f21..9272f9d5 100644 --- a/docs/models/accountinginvoicesdeleterequest.md +++ b/docs/models/accountinginvoicesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinginvoicesonerequest.md b/docs/models/accountinginvoicesonerequest.md index 36298d48..f4f52d63 100644 --- a/docs/models/accountinginvoicesonerequest.md +++ b/docs/models/accountinginvoicesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountinginvoicesupdaterequest.md b/docs/models/accountinginvoicesupdaterequest.md index 2a25bea5..94bbfb6e 100644 --- a/docs/models/accountinginvoicesupdaterequest.md +++ b/docs/models/accountinginvoicesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `invoice` | [models.InvoiceInput](../models/invoiceinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesaddrequest.md b/docs/models/accountingjournalentriesaddrequest.md index 332e0743..d48061b0 100644 --- a/docs/models/accountingjournalentriesaddrequest.md +++ b/docs/models/accountingjournalentriesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesallrequest.md b/docs/models/accountingjournalentriesallrequest.md index dcb350dd..0001d88a 100644 --- a/docs/models/accountingjournalentriesallrequest.md +++ b/docs/models/accountingjournalentriesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingjournalentriesdeleterequest.md b/docs/models/accountingjournalentriesdeleterequest.md index 2d68db1f..45f47d79 100644 --- a/docs/models/accountingjournalentriesdeleterequest.md +++ b/docs/models/accountingjournalentriesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesonerequest.md b/docs/models/accountingjournalentriesonerequest.md index 46d32932..bc06bf6e 100644 --- a/docs/models/accountingjournalentriesonerequest.md +++ b/docs/models/accountingjournalentriesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingjournalentriesupdaterequest.md b/docs/models/accountingjournalentriesupdaterequest.md index 62455d18..4d3b0bd3 100644 --- a/docs/models/accountingjournalentriesupdaterequest.md +++ b/docs/models/accountingjournalentriesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `journal_entry` | [models.JournalEntryInput](../models/journalentryinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsaddrequest.md b/docs/models/accountingledgeraccountsaddrequest.md index a04667ce..b3c09ddc 100644 --- a/docs/models/accountingledgeraccountsaddrequest.md +++ b/docs/models/accountingledgeraccountsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsallrequest.md b/docs/models/accountingledgeraccountsallrequest.md index f33e98a8..1b234be3 100644 --- a/docs/models/accountingledgeraccountsallrequest.md +++ b/docs/models/accountingledgeraccountsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingledgeraccountsdeleterequest.md b/docs/models/accountingledgeraccountsdeleterequest.md index 67e15d38..44e70754 100644 --- a/docs/models/accountingledgeraccountsdeleterequest.md +++ b/docs/models/accountingledgeraccountsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsonerequest.md b/docs/models/accountingledgeraccountsonerequest.md index f25b49b4..8d8bc184 100644 --- a/docs/models/accountingledgeraccountsonerequest.md +++ b/docs/models/accountingledgeraccountsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingledgeraccountsupdaterequest.md b/docs/models/accountingledgeraccountsupdaterequest.md index ba10053e..4ce90327 100644 --- a/docs/models/accountingledgeraccountsupdaterequest.md +++ b/docs/models/accountingledgeraccountsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `ledger_account` | [models.LedgerAccountInput](../models/ledgeraccountinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinglocationsaddrequest.md b/docs/models/accountinglocationsaddrequest.md index df68bcda..ff0ba131 100644 --- a/docs/models/accountinglocationsaddrequest.md +++ b/docs/models/accountinglocationsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountinglocationsallrequest.md b/docs/models/accountinglocationsallrequest.md index de111071..ef50791a 100644 --- a/docs/models/accountinglocationsallrequest.md +++ b/docs/models/accountinglocationsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountinglocationsdeleterequest.md b/docs/models/accountinglocationsdeleterequest.md index e725ea67..c0b92f2c 100644 --- a/docs/models/accountinglocationsdeleterequest.md +++ b/docs/models/accountinglocationsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountinglocationsonerequest.md b/docs/models/accountinglocationsonerequest.md index 345b1efa..96aa260d 100644 --- a/docs/models/accountinglocationsonerequest.md +++ b/docs/models/accountinglocationsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountinglocationsupdaterequest.md b/docs/models/accountinglocationsupdaterequest.md index dae987b9..aacb4c67 100644 --- a/docs/models/accountinglocationsupdaterequest.md +++ b/docs/models/accountinglocationsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `accounting_location` | [models.AccountingLocationInput](../models/accountinglocationinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingpaymentsaddrequest.md b/docs/models/accountingpaymentsaddrequest.md index 89e8c6a4..ee392587 100644 --- a/docs/models/accountingpaymentsaddrequest.md +++ b/docs/models/accountingpaymentsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingpaymentsallrequest.md b/docs/models/accountingpaymentsallrequest.md index 471b9656..e068987d 100644 --- a/docs/models/accountingpaymentsallrequest.md +++ b/docs/models/accountingpaymentsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingpaymentsdeleterequest.md b/docs/models/accountingpaymentsdeleterequest.md index 0c8d4640..db072531 100644 --- a/docs/models/accountingpaymentsdeleterequest.md +++ b/docs/models/accountingpaymentsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingpaymentsonerequest.md b/docs/models/accountingpaymentsonerequest.md index e735cebc..a5953c03 100644 --- a/docs/models/accountingpaymentsonerequest.md +++ b/docs/models/accountingpaymentsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingpaymentsupdaterequest.md b/docs/models/accountingpaymentsupdaterequest.md index e8bf18ad..7085e5d3 100644 --- a/docs/models/accountingpaymentsupdaterequest.md +++ b/docs/models/accountingpaymentsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `payment` | [models.PaymentInput](../models/paymentinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingprofitandlossonerequest.md b/docs/models/accountingprofitandlossonerequest.md index 2fb9c50f..deb76336 100644 --- a/docs/models/accountingprofitandlossonerequest.md +++ b/docs/models/accountingprofitandlossonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.ProfitAndLossFilter]](../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/accountingpurchaseordersaddrequest.md b/docs/models/accountingpurchaseordersaddrequest.md index 4b755de7..fe106156 100644 --- a/docs/models/accountingpurchaseordersaddrequest.md +++ b/docs/models/accountingpurchaseordersaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingpurchaseordersallrequest.md b/docs/models/accountingpurchaseordersallrequest.md index f2d9ae6e..28ae1048 100644 --- a/docs/models/accountingpurchaseordersallrequest.md +++ b/docs/models/accountingpurchaseordersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/accountingpurchaseordersdeleterequest.md b/docs/models/accountingpurchaseordersdeleterequest.md index e4938c25..0c35fb1f 100644 --- a/docs/models/accountingpurchaseordersdeleterequest.md +++ b/docs/models/accountingpurchaseordersdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingpurchaseordersonerequest.md b/docs/models/accountingpurchaseordersonerequest.md index f91b4bb5..4e5bb50e 100644 --- a/docs/models/accountingpurchaseordersonerequest.md +++ b/docs/models/accountingpurchaseordersonerequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingpurchaseordersupdaterequest.md b/docs/models/accountingpurchaseordersupdaterequest.md index 4ea083a5..77eca894 100644 --- a/docs/models/accountingpurchaseordersupdaterequest.md +++ b/docs/models/accountingpurchaseordersupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `purchase_order` | [models.PurchaseOrderInput](../models/purchaseorderinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesaddrequest.md b/docs/models/accountingsubsidiariesaddrequest.md index 76d3b03a..82fc1d0e 100644 --- a/docs/models/accountingsubsidiariesaddrequest.md +++ b/docs/models/accountingsubsidiariesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesallrequest.md b/docs/models/accountingsubsidiariesallrequest.md index 6b2de35c..8c5ad6a7 100644 --- a/docs/models/accountingsubsidiariesallrequest.md +++ b/docs/models/accountingsubsidiariesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingsubsidiariesdeleterequest.md b/docs/models/accountingsubsidiariesdeleterequest.md index 34b30207..010588cc 100644 --- a/docs/models/accountingsubsidiariesdeleterequest.md +++ b/docs/models/accountingsubsidiariesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesonerequest.md b/docs/models/accountingsubsidiariesonerequest.md index 0a62822c..286bf70f 100644 --- a/docs/models/accountingsubsidiariesonerequest.md +++ b/docs/models/accountingsubsidiariesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingsubsidiariesupdaterequest.md b/docs/models/accountingsubsidiariesupdaterequest.md index 5e496f1e..9525c98d 100644 --- a/docs/models/accountingsubsidiariesupdaterequest.md +++ b/docs/models/accountingsubsidiariesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `subsidiary` | [models.SubsidiaryInput](../models/subsidiaryinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingsuppliersaddrequest.md b/docs/models/accountingsuppliersaddrequest.md index cb9cf4e8..669dbc7e 100644 --- a/docs/models/accountingsuppliersaddrequest.md +++ b/docs/models/accountingsuppliersaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingsuppliersallrequest.md b/docs/models/accountingsuppliersallrequest.md index 1e1f4dcb..23468c53 100644 --- a/docs/models/accountingsuppliersallrequest.md +++ b/docs/models/accountingsuppliersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingsuppliersdeleterequest.md b/docs/models/accountingsuppliersdeleterequest.md index 8f5b4c67..3c1d64e5 100644 --- a/docs/models/accountingsuppliersdeleterequest.md +++ b/docs/models/accountingsuppliersdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingsuppliersonerequest.md b/docs/models/accountingsuppliersonerequest.md index c0f5a842..2117fbdd 100644 --- a/docs/models/accountingsuppliersonerequest.md +++ b/docs/models/accountingsuppliersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingsuppliersupdaterequest.md b/docs/models/accountingsuppliersupdaterequest.md index 14175b27..a6279807 100644 --- a/docs/models/accountingsuppliersupdaterequest.md +++ b/docs/models/accountingsuppliersupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `supplier` | [models.SupplierInput](../models/supplierinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingtaxratesaddrequest.md b/docs/models/accountingtaxratesaddrequest.md index 9aaa603c..6859a0c7 100644 --- a/docs/models/accountingtaxratesaddrequest.md +++ b/docs/models/accountingtaxratesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingtaxratesallrequest.md b/docs/models/accountingtaxratesallrequest.md index d823df68..b42fe63f 100644 --- a/docs/models/accountingtaxratesallrequest.md +++ b/docs/models/accountingtaxratesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingtaxratesdeleterequest.md b/docs/models/accountingtaxratesdeleterequest.md index 989731d4..d0651b48 100644 --- a/docs/models/accountingtaxratesdeleterequest.md +++ b/docs/models/accountingtaxratesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingtaxratesonerequest.md b/docs/models/accountingtaxratesonerequest.md index e7ca8df8..b6b6b356 100644 --- a/docs/models/accountingtaxratesonerequest.md +++ b/docs/models/accountingtaxratesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingtaxratesupdaterequest.md b/docs/models/accountingtaxratesupdaterequest.md index 8ce2d33c..16194067 100644 --- a/docs/models/accountingtaxratesupdaterequest.md +++ b/docs/models/accountingtaxratesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesaddrequest.md b/docs/models/accountingtrackingcategoriesaddrequest.md index 675d0082..f09a1e40 100644 --- a/docs/models/accountingtrackingcategoriesaddrequest.md +++ b/docs/models/accountingtrackingcategoriesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesallrequest.md b/docs/models/accountingtrackingcategoriesallrequest.md index 683dc2b6..ee194a6e 100644 --- a/docs/models/accountingtrackingcategoriesallrequest.md +++ b/docs/models/accountingtrackingcategoriesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/accountingtrackingcategoriesdeleterequest.md b/docs/models/accountingtrackingcategoriesdeleterequest.md index 1e300de4..b8d97618 100644 --- a/docs/models/accountingtrackingcategoriesdeleterequest.md +++ b/docs/models/accountingtrackingcategoriesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesonerequest.md b/docs/models/accountingtrackingcategoriesonerequest.md index b090d36b..c449eff1 100644 --- a/docs/models/accountingtrackingcategoriesonerequest.md +++ b/docs/models/accountingtrackingcategoriesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/accountingtrackingcategoriesupdaterequest.md b/docs/models/accountingtrackingcategoriesupdaterequest.md index 884030b4..2837eba7 100644 --- a/docs/models/accountingtrackingcategoriesupdaterequest.md +++ b/docs/models/accountingtrackingcategoriesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `tracking_category` | [models.TrackingCategoryInput](../models/trackingcategoryinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsapplicantsaddrequest.md b/docs/models/atsapplicantsaddrequest.md index c3927797..1c81f866 100644 --- a/docs/models/atsapplicantsaddrequest.md +++ b/docs/models/atsapplicantsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/atsapplicantsallrequest.md b/docs/models/atsapplicantsallrequest.md index 15859343..d87f2fb1 100644 --- a/docs/models/atsapplicantsallrequest.md +++ b/docs/models/atsapplicantsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/atsapplicantsdeleterequest.md b/docs/models/atsapplicantsdeleterequest.md index e55e684e..ed247e6a 100644 --- a/docs/models/atsapplicantsdeleterequest.md +++ b/docs/models/atsapplicantsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsapplicantsonerequest.md b/docs/models/atsapplicantsonerequest.md index 4027bd79..0fb2b211 100644 --- a/docs/models/atsapplicantsonerequest.md +++ b/docs/models/atsapplicantsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/atsapplicantsupdaterequest.md b/docs/models/atsapplicantsupdaterequest.md index 3671d06a..61f86a2e 100644 --- a/docs/models/atsapplicantsupdaterequest.md +++ b/docs/models/atsapplicantsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `applicant` | [models.ApplicantInput](../models/applicantinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsapplicationsaddrequest.md b/docs/models/atsapplicationsaddrequest.md index f206aa54..354c14f9 100644 --- a/docs/models/atsapplicationsaddrequest.md +++ b/docs/models/atsapplicationsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/atsapplicationsallrequest.md b/docs/models/atsapplicationsallrequest.md index 0dd2b8d6..1f09a102 100644 --- a/docs/models/atsapplicationsallrequest.md +++ b/docs/models/atsapplicationsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/atsapplicationsdeleterequest.md b/docs/models/atsapplicationsdeleterequest.md index 85f00c36..f674200c 100644 --- a/docs/models/atsapplicationsdeleterequest.md +++ b/docs/models/atsapplicationsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsapplicationsonerequest.md b/docs/models/atsapplicationsonerequest.md index 10445dda..600f538e 100644 --- a/docs/models/atsapplicationsonerequest.md +++ b/docs/models/atsapplicationsonerequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsapplicationsupdaterequest.md b/docs/models/atsapplicationsupdaterequest.md index 56765eda..8c7f82ae 100644 --- a/docs/models/atsapplicationsupdaterequest.md +++ b/docs/models/atsapplicationsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `application` | [models.ApplicationInput](../models/applicationinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/atsjobsallrequest.md b/docs/models/atsjobsallrequest.md index 613373d7..3056d263 100644 --- a/docs/models/atsjobsallrequest.md +++ b/docs/models/atsjobsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/atsjobsonerequest.md b/docs/models/atsjobsonerequest.md index d820b6b5..d14b1d23 100644 --- a/docs/models/atsjobsonerequest.md +++ b/docs/models/atsjobsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/connectorapiresourcecoverageonerequest.md b/docs/models/connectorapiresourcecoverageonerequest.md index db5d5f2a..0667b110 100644 --- a/docs/models/connectorapiresourcecoverageonerequest.md +++ b/docs/models/connectorapiresourcecoverageonerequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/connectorapiresourcesonerequest.md b/docs/models/connectorapiresourcesonerequest.md index 24e9aed7..d7e0c589 100644 --- a/docs/models/connectorapiresourcesonerequest.md +++ b/docs/models/connectorapiresourcesonerequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/connectorapisallrequest.md b/docs/models/connectorapisallrequest.md index 9655e912..2cc1f94b 100644 --- a/docs/models/connectorapisallrequest.md +++ b/docs/models/connectorapisallrequest.md @@ -5,6 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | | `filter_` | [Optional[models.ApisFilter]](../models/apisfilter.md) | :heavy_minus_sign: | Apply filters | {
"status": "beta"
} | \ No newline at end of file diff --git a/docs/models/connectorapisonerequest.md b/docs/models/connectorapisonerequest.md index 35a8bf71..bd06dd28 100644 --- a/docs/models/connectorapisonerequest.md +++ b/docs/models/connectorapisonerequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/connectorconnectordocsonerequest.md b/docs/models/connectorconnectordocsonerequest.md index 577ff5b2..fa6fad6c 100644 --- a/docs/models/connectorconnectordocsonerequest.md +++ b/docs/models/connectorconnectordocsonerequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `doc_id` | *str* | :heavy_check_mark: | ID of the Doc | application_owner+oauth_credentials | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `doc_id` | *str* | :heavy_check_mark: | ID of the Doc | application_owner+oauth_credentials | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/connectorconnectorresourcesonerequest.md b/docs/models/connectorconnectorresourcesonerequest.md index 5ea119d0..5e2fa75a 100644 --- a/docs/models/connectorconnectorresourcesonerequest.md +++ b/docs/models/connectorconnectorresourcesonerequest.md @@ -7,4 +7,5 @@ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | [Optional[models.UnifiedAPIID]](../models/unifiedapiid.md) | :heavy_minus_sign: | Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs | crm | \ No newline at end of file diff --git a/docs/models/connectorconnectorsallrequest.md b/docs/models/connectorconnectorsallrequest.md index 5528aba2..2cbb11ef 100644 --- a/docs/models/connectorconnectorsallrequest.md +++ b/docs/models/connectorconnectorsallrequest.md @@ -5,6 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | | `filter_` | [Optional[models.ConnectorsFilter]](../models/connectorsfilter.md) | :heavy_minus_sign: | Apply filters | {
"unified_api": "file-storage"
} | \ No newline at end of file diff --git a/docs/models/connectorconnectorsonerequest.md b/docs/models/connectorconnectorsonerequest.md index 559b5019..0a24f2ee 100644 --- a/docs/models/connectorconnectorsonerequest.md +++ b/docs/models/connectorconnectorsonerequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/createaccountingdepartmentresponse.md b/docs/models/createaccountingdepartmentresponse.md index 7fe8abe9..e9be7d63 100644 --- a/docs/models/createaccountingdepartmentresponse.md +++ b/docs/models/createaccountingdepartmentresponse.md @@ -5,11 +5,11 @@ Department ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createaccountinglocationresponse.md b/docs/models/createaccountinglocationresponse.md index b1a3cf49..adf80bb3 100644 --- a/docs/models/createaccountinglocationresponse.md +++ b/docs/models/createaccountinglocationresponse.md @@ -5,11 +5,11 @@ Location ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createactivityresponse.md b/docs/models/createactivityresponse.md index 89796188..d948d83b 100644 --- a/docs/models/createactivityresponse.md +++ b/docs/models/createactivityresponse.md @@ -5,11 +5,11 @@ Activity created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createapplicantresponse.md b/docs/models/createapplicantresponse.md index 8236c255..05b5e782 100644 --- a/docs/models/createapplicantresponse.md +++ b/docs/models/createapplicantresponse.md @@ -5,11 +5,11 @@ Applicants ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createapplicationresponse.md b/docs/models/createapplicationresponse.md index a400beb6..f282f496 100644 --- a/docs/models/createapplicationresponse.md +++ b/docs/models/createapplicationresponse.md @@ -5,11 +5,11 @@ Applications ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createbillpaymentresponse.md b/docs/models/createbillpaymentresponse.md index 83541d57..fd348516 100644 --- a/docs/models/createbillpaymentresponse.md +++ b/docs/models/createbillpaymentresponse.md @@ -5,11 +5,11 @@ Bill Payment created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createbillresponse.md b/docs/models/createbillresponse.md index 26b873f6..0bfec3be 100644 --- a/docs/models/createbillresponse.md +++ b/docs/models/createbillresponse.md @@ -5,11 +5,11 @@ Bill created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createcommentresponse.md b/docs/models/createcommentresponse.md index 66d61ffa..477c1c10 100644 --- a/docs/models/createcommentresponse.md +++ b/docs/models/createcommentresponse.md @@ -5,11 +5,11 @@ Create a Comment ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createcompanyresponse.md b/docs/models/createcompanyresponse.md index e560b885..bc4692c3 100644 --- a/docs/models/createcompanyresponse.md +++ b/docs/models/createcompanyresponse.md @@ -5,11 +5,11 @@ Company created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createcontactresponse.md b/docs/models/createcontactresponse.md index bcec4387..b9bab1d4 100644 --- a/docs/models/createcontactresponse.md +++ b/docs/models/createcontactresponse.md @@ -5,11 +5,11 @@ Contact created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createcreditnoteresponse.md b/docs/models/createcreditnoteresponse.md index 73839b4e..09a61480 100644 --- a/docs/models/createcreditnoteresponse.md +++ b/docs/models/createcreditnoteresponse.md @@ -5,11 +5,11 @@ Credit Note created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createcustomerresponse.md b/docs/models/createcustomerresponse.md index 1b0cdd8b..2b235030 100644 --- a/docs/models/createcustomerresponse.md +++ b/docs/models/createcustomerresponse.md @@ -5,11 +5,11 @@ Customers ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createdepartmentresponse.md b/docs/models/createdepartmentresponse.md index 9c54b8d4..2aea1085 100644 --- a/docs/models/createdepartmentresponse.md +++ b/docs/models/createdepartmentresponse.md @@ -5,11 +5,11 @@ Departments ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createdrivegroupresponse.md b/docs/models/createdrivegroupresponse.md index 80f4e7db..5065d685 100644 --- a/docs/models/createdrivegroupresponse.md +++ b/docs/models/createdrivegroupresponse.md @@ -5,11 +5,11 @@ DriveGroups ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createdriveresponse.md b/docs/models/createdriveresponse.md index 7bf65943..68e3485f 100644 --- a/docs/models/createdriveresponse.md +++ b/docs/models/createdriveresponse.md @@ -5,11 +5,11 @@ Drives ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createemployeeresponse.md b/docs/models/createemployeeresponse.md index e3db744f..6e4eea2a 100644 --- a/docs/models/createemployeeresponse.md +++ b/docs/models/createemployeeresponse.md @@ -5,11 +5,11 @@ Employees ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createexpenseresponse.md b/docs/models/createexpenseresponse.md index 3aebf1b0..0c22a543 100644 --- a/docs/models/createexpenseresponse.md +++ b/docs/models/createexpenseresponse.md @@ -5,11 +5,11 @@ Expenses ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createfolderresponse.md b/docs/models/createfolderresponse.md index 9be4934f..aaa36709 100644 --- a/docs/models/createfolderresponse.md +++ b/docs/models/createfolderresponse.md @@ -5,11 +5,11 @@ Folders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createhriscompanyresponse.md b/docs/models/createhriscompanyresponse.md index 2bbe34a6..f7a49322 100644 --- a/docs/models/createhriscompanyresponse.md +++ b/docs/models/createhriscompanyresponse.md @@ -5,11 +5,11 @@ Companies ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createinvoiceitemresponse.md b/docs/models/createinvoiceitemresponse.md index 3c14eee7..f4ef0643 100644 --- a/docs/models/createinvoiceitemresponse.md +++ b/docs/models/createinvoiceitemresponse.md @@ -5,11 +5,11 @@ InvoiceItems ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | invoice-items | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | invoice-items | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createjournalentryresponse.md b/docs/models/createjournalentryresponse.md index 5d2511e7..972b1a59 100644 --- a/docs/models/createjournalentryresponse.md +++ b/docs/models/createjournalentryresponse.md @@ -5,11 +5,11 @@ JournalEntries ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createleadresponse.md b/docs/models/createleadresponse.md index f766dd37..77743e92 100644 --- a/docs/models/createleadresponse.md +++ b/docs/models/createleadresponse.md @@ -5,11 +5,11 @@ Lead created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createledgeraccountresponse.md b/docs/models/createledgeraccountresponse.md index ed4e80d0..d6e8e4a2 100644 --- a/docs/models/createledgeraccountresponse.md +++ b/docs/models/createledgeraccountresponse.md @@ -5,11 +5,11 @@ LedgerAccount created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createmessageresponse.md b/docs/models/createmessageresponse.md index b5c24e30..4f778c45 100644 --- a/docs/models/createmessageresponse.md +++ b/docs/models/createmessageresponse.md @@ -5,11 +5,11 @@ Messages ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createnoteresponse.md b/docs/models/createnoteresponse.md index 27be5c88..64518dad 100644 --- a/docs/models/createnoteresponse.md +++ b/docs/models/createnoteresponse.md @@ -5,11 +5,11 @@ Note created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createopportunityresponse.md b/docs/models/createopportunityresponse.md index 10d893e8..674ba8b2 100644 --- a/docs/models/createopportunityresponse.md +++ b/docs/models/createopportunityresponse.md @@ -5,11 +5,11 @@ Opportunity created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | opportunities | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | opportunities | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createpaymentresponse.md b/docs/models/createpaymentresponse.md index cd23db53..91430b89 100644 --- a/docs/models/createpaymentresponse.md +++ b/docs/models/createpaymentresponse.md @@ -5,11 +5,11 @@ Payment created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createpurchaseorderresponse.md b/docs/models/createpurchaseorderresponse.md index 0781b50b..8e4c1686 100644 --- a/docs/models/createpurchaseorderresponse.md +++ b/docs/models/createpurchaseorderresponse.md @@ -5,11 +5,11 @@ PurchaseOrders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createsharedlinkresponse.md b/docs/models/createsharedlinkresponse.md index 08a5783b..3a800836 100644 --- a/docs/models/createsharedlinkresponse.md +++ b/docs/models/createsharedlinkresponse.md @@ -5,11 +5,11 @@ Shared Links ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createsubsidiaryresponse.md b/docs/models/createsubsidiaryresponse.md index 737e5c3f..8fa0efe1 100644 --- a/docs/models/createsubsidiaryresponse.md +++ b/docs/models/createsubsidiaryresponse.md @@ -5,11 +5,11 @@ Subsidiaries ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createsupplierresponse.md b/docs/models/createsupplierresponse.md index 42b6a82d..1cd3c6f7 100644 --- a/docs/models/createsupplierresponse.md +++ b/docs/models/createsupplierresponse.md @@ -5,11 +5,11 @@ Supplier created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createtaxrateresponse.md b/docs/models/createtaxrateresponse.md index 415a6b5a..d2f4dca7 100644 --- a/docs/models/createtaxrateresponse.md +++ b/docs/models/createtaxrateresponse.md @@ -5,11 +5,11 @@ TaxRate created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createticketresponse.md b/docs/models/createticketresponse.md index 0ead6b52..292a1cae 100644 --- a/docs/models/createticketresponse.md +++ b/docs/models/createticketresponse.md @@ -5,11 +5,11 @@ Create a Ticket ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createtimeoffrequestresponse.md b/docs/models/createtimeoffrequestresponse.md index aeab5a24..dd74c1c6 100644 --- a/docs/models/createtimeoffrequestresponse.md +++ b/docs/models/createtimeoffrequestresponse.md @@ -5,11 +5,11 @@ TimeOffRequests ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createtrackingcategoryresponse.md b/docs/models/createtrackingcategoryresponse.md index a6296182..95de4c8d 100644 --- a/docs/models/createtrackingcategoryresponse.md +++ b/docs/models/createtrackingcategoryresponse.md @@ -5,11 +5,11 @@ Tracking category created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createuploadsessionresponse.md b/docs/models/createuploadsessionresponse.md index 702ac66d..aee5974f 100644 --- a/docs/models/createuploadsessionresponse.md +++ b/docs/models/createuploadsessionresponse.md @@ -5,11 +5,11 @@ UploadSessions ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | UploadSessions | -| `operation` | *str* | :heavy_check_mark: | Operation performed | one | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | UploadSessions | +| `operation` | *str* | :heavy_check_mark: | Operation performed | one | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/createuserresponse.md b/docs/models/createuserresponse.md index a3b9e726..0babeb59 100644 --- a/docs/models/createuserresponse.md +++ b/docs/models/createuserresponse.md @@ -5,11 +5,11 @@ User created ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | users | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | users | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/crmactivitiesaddrequest.md b/docs/models/crmactivitiesaddrequest.md index a1ae9fb9..ae123a2d 100644 --- a/docs/models/crmactivitiesaddrequest.md +++ b/docs/models/crmactivitiesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmactivitiesallrequest.md b/docs/models/crmactivitiesallrequest.md index ef9f8aed..d5d8329a 100644 --- a/docs/models/crmactivitiesallrequest.md +++ b/docs/models/crmactivitiesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmactivitiesdeleterequest.md b/docs/models/crmactivitiesdeleterequest.md index e21794b4..cc732b75 100644 --- a/docs/models/crmactivitiesdeleterequest.md +++ b/docs/models/crmactivitiesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmactivitiesonerequest.md b/docs/models/crmactivitiesonerequest.md index 12e53577..00e2cc88 100644 --- a/docs/models/crmactivitiesonerequest.md +++ b/docs/models/crmactivitiesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmactivitiesupdaterequest.md b/docs/models/crmactivitiesupdaterequest.md index b531dffa..c27872c1 100644 --- a/docs/models/crmactivitiesupdaterequest.md +++ b/docs/models/crmactivitiesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `activity` | [models.ActivityInput](../models/activityinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmcompaniesaddrequest.md b/docs/models/crmcompaniesaddrequest.md index 4a6b20a5..d2c8252d 100644 --- a/docs/models/crmcompaniesaddrequest.md +++ b/docs/models/crmcompaniesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmcompaniesallrequest.md b/docs/models/crmcompaniesallrequest.md index 9c178747..cdae5b8e 100644 --- a/docs/models/crmcompaniesallrequest.md +++ b/docs/models/crmcompaniesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmcompaniesdeleterequest.md b/docs/models/crmcompaniesdeleterequest.md index 43c61ed3..d3cb7265 100644 --- a/docs/models/crmcompaniesdeleterequest.md +++ b/docs/models/crmcompaniesdeleterequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmcompaniesonerequest.md b/docs/models/crmcompaniesonerequest.md index 32de779c..945ee9db 100644 --- a/docs/models/crmcompaniesonerequest.md +++ b/docs/models/crmcompaniesonerequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmcompaniesupdaterequest.md b/docs/models/crmcompaniesupdaterequest.md index 463fe38d..671e0b59 100644 --- a/docs/models/crmcompaniesupdaterequest.md +++ b/docs/models/crmcompaniesupdaterequest.md @@ -8,4 +8,6 @@ | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `company` | [models.CompanyInput](../models/companyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmcontactsaddrequest.md b/docs/models/crmcontactsaddrequest.md index 0cae452a..c639e5e7 100644 --- a/docs/models/crmcontactsaddrequest.md +++ b/docs/models/crmcontactsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmcontactsallrequest.md b/docs/models/crmcontactsallrequest.md index 50a6c978..d11d31b3 100644 --- a/docs/models/crmcontactsallrequest.md +++ b/docs/models/crmcontactsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmcontactsdeleterequest.md b/docs/models/crmcontactsdeleterequest.md index 3afc5182..aae97c50 100644 --- a/docs/models/crmcontactsdeleterequest.md +++ b/docs/models/crmcontactsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmcontactsonerequest.md b/docs/models/crmcontactsonerequest.md index ece32a85..5d2f22d2 100644 --- a/docs/models/crmcontactsonerequest.md +++ b/docs/models/crmcontactsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/models/crmcontactsupdaterequest.md b/docs/models/crmcontactsupdaterequest.md index f22d9995..8ede417b 100644 --- a/docs/models/crmcontactsupdaterequest.md +++ b/docs/models/crmcontactsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `contact` | [models.ContactInput](../models/contactinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmleadsaddrequest.md b/docs/models/crmleadsaddrequest.md index 32e9b164..e60b46f8 100644 --- a/docs/models/crmleadsaddrequest.md +++ b/docs/models/crmleadsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmleadsallrequest.md b/docs/models/crmleadsallrequest.md index 920e3924..c490a6ab 100644 --- a/docs/models/crmleadsallrequest.md +++ b/docs/models/crmleadsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmleadsdeleterequest.md b/docs/models/crmleadsdeleterequest.md index 9deead5b..3b98fea5 100644 --- a/docs/models/crmleadsdeleterequest.md +++ b/docs/models/crmleadsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmleadsonerequest.md b/docs/models/crmleadsonerequest.md index c3099898..d9fefd56 100644 --- a/docs/models/crmleadsonerequest.md +++ b/docs/models/crmleadsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmleadsupdaterequest.md b/docs/models/crmleadsupdaterequest.md index 31028c6c..2bd3b814 100644 --- a/docs/models/crmleadsupdaterequest.md +++ b/docs/models/crmleadsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `lead` | [models.LeadInput](../models/leadinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmnotesaddrequest.md b/docs/models/crmnotesaddrequest.md index 3e296527..f6254ed4 100644 --- a/docs/models/crmnotesaddrequest.md +++ b/docs/models/crmnotesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmnotesallrequest.md b/docs/models/crmnotesallrequest.md index 35b70e7e..2eaf2772 100644 --- a/docs/models/crmnotesallrequest.md +++ b/docs/models/crmnotesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmnotesdeleterequest.md b/docs/models/crmnotesdeleterequest.md index 2efa8030..78b0910a 100644 --- a/docs/models/crmnotesdeleterequest.md +++ b/docs/models/crmnotesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmnotesonerequest.md b/docs/models/crmnotesonerequest.md index afa40f03..bd219eaa 100644 --- a/docs/models/crmnotesonerequest.md +++ b/docs/models/crmnotesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmnotesupdaterequest.md b/docs/models/crmnotesupdaterequest.md index 203ad5a2..020f6b24 100644 --- a/docs/models/crmnotesupdaterequest.md +++ b/docs/models/crmnotesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `note` | [models.NoteInput](../models/noteinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmopportunitiesaddrequest.md b/docs/models/crmopportunitiesaddrequest.md index 8f14bba2..073388f3 100644 --- a/docs/models/crmopportunitiesaddrequest.md +++ b/docs/models/crmopportunitiesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmopportunitiesallrequest.md b/docs/models/crmopportunitiesallrequest.md index ad1a0971..516e7c85 100644 --- a/docs/models/crmopportunitiesallrequest.md +++ b/docs/models/crmopportunitiesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmopportunitiesdeleterequest.md b/docs/models/crmopportunitiesdeleterequest.md index 68a7437a..22f4df35 100644 --- a/docs/models/crmopportunitiesdeleterequest.md +++ b/docs/models/crmopportunitiesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmopportunitiesonerequest.md b/docs/models/crmopportunitiesonerequest.md index 1e308569..f0a1bd41 100644 --- a/docs/models/crmopportunitiesonerequest.md +++ b/docs/models/crmopportunitiesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmopportunitiesupdaterequest.md b/docs/models/crmopportunitiesupdaterequest.md index 569d07aa..9181789b 100644 --- a/docs/models/crmopportunitiesupdaterequest.md +++ b/docs/models/crmopportunitiesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `opportunity` | [models.OpportunityInput](../models/opportunityinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmpipelinesallrequest.md b/docs/models/crmpipelinesallrequest.md index 8ca9f3e6..aed7dadb 100644 --- a/docs/models/crmpipelinesallrequest.md +++ b/docs/models/crmpipelinesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmusersaddrequest.md b/docs/models/crmusersaddrequest.md index 64a4ed1d..27bcc84d 100644 --- a/docs/models/crmusersaddrequest.md +++ b/docs/models/crmusersaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/crmusersallrequest.md b/docs/models/crmusersallrequest.md index 2e63fdc5..a2df8759 100644 --- a/docs/models/crmusersallrequest.md +++ b/docs/models/crmusersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/crmusersdeleterequest.md b/docs/models/crmusersdeleterequest.md index b3850c9d..2a825287 100644 --- a/docs/models/crmusersdeleterequest.md +++ b/docs/models/crmusersdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/crmusersonerequest.md b/docs/models/crmusersonerequest.md index 3b674a49..7bfc911b 100644 --- a/docs/models/crmusersonerequest.md +++ b/docs/models/crmusersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/crmusersupdaterequest.md b/docs/models/crmusersupdaterequest.md index 0194405f..be12daa4 100644 --- a/docs/models/crmusersupdaterequest.md +++ b/docs/models/crmusersupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `user` | [models.UserInput](../models/userinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/deleteaccountingdepartmentresponse.md b/docs/models/deleteaccountingdepartmentresponse.md index d142fc15..ecc34fb3 100644 --- a/docs/models/deleteaccountingdepartmentresponse.md +++ b/docs/models/deleteaccountingdepartmentresponse.md @@ -5,11 +5,11 @@ Department deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteaccountinglocationresponse.md b/docs/models/deleteaccountinglocationresponse.md index cd22e418..c7a7ad13 100644 --- a/docs/models/deleteaccountinglocationresponse.md +++ b/docs/models/deleteaccountinglocationresponse.md @@ -5,11 +5,11 @@ Location deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteactivityresponse.md b/docs/models/deleteactivityresponse.md index aee141ac..1990dc28 100644 --- a/docs/models/deleteactivityresponse.md +++ b/docs/models/deleteactivityresponse.md @@ -5,11 +5,11 @@ Activity deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteapplicantresponse.md b/docs/models/deleteapplicantresponse.md index 3deed410..62acee83 100644 --- a/docs/models/deleteapplicantresponse.md +++ b/docs/models/deleteapplicantresponse.md @@ -5,11 +5,11 @@ Applicants ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteapplicationresponse.md b/docs/models/deleteapplicationresponse.md index 068ed87d..f278f3b2 100644 --- a/docs/models/deleteapplicationresponse.md +++ b/docs/models/deleteapplicationresponse.md @@ -5,11 +5,11 @@ Applications ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteattachmentresponse.md b/docs/models/deleteattachmentresponse.md index 21e54904..a2e2e3c8 100644 --- a/docs/models/deleteattachmentresponse.md +++ b/docs/models/deleteattachmentresponse.md @@ -5,11 +5,11 @@ Attachments ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletebillpaymentresponse.md b/docs/models/deletebillpaymentresponse.md index e56388e7..41feb5e4 100644 --- a/docs/models/deletebillpaymentresponse.md +++ b/docs/models/deletebillpaymentresponse.md @@ -5,11 +5,11 @@ Bill Payment deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletebillresponse.md b/docs/models/deletebillresponse.md index 64db85ac..01e0aeb2 100644 --- a/docs/models/deletebillresponse.md +++ b/docs/models/deletebillresponse.md @@ -5,11 +5,11 @@ Bill deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletecommentresponse.md b/docs/models/deletecommentresponse.md index 94b41d84..b27174d7 100644 --- a/docs/models/deletecommentresponse.md +++ b/docs/models/deletecommentresponse.md @@ -5,11 +5,11 @@ Delete a Comment ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletecompanyresponse.md b/docs/models/deletecompanyresponse.md index 55c10521..342ed8f8 100644 --- a/docs/models/deletecompanyresponse.md +++ b/docs/models/deletecompanyresponse.md @@ -5,11 +5,11 @@ Company deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletecontactresponse.md b/docs/models/deletecontactresponse.md index cb15fae7..7675bba4 100644 --- a/docs/models/deletecontactresponse.md +++ b/docs/models/deletecontactresponse.md @@ -5,11 +5,11 @@ Contact deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletecreditnoteresponse.md b/docs/models/deletecreditnoteresponse.md index 512ffa89..e4861c31 100644 --- a/docs/models/deletecreditnoteresponse.md +++ b/docs/models/deletecreditnoteresponse.md @@ -5,11 +5,11 @@ Credit Note deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletecustomerresponse.md b/docs/models/deletecustomerresponse.md index 4f049094..b78fd0cb 100644 --- a/docs/models/deletecustomerresponse.md +++ b/docs/models/deletecustomerresponse.md @@ -5,11 +5,11 @@ Customers ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletedepartmentresponse.md b/docs/models/deletedepartmentresponse.md index 91937a92..be383f58 100644 --- a/docs/models/deletedepartmentresponse.md +++ b/docs/models/deletedepartmentresponse.md @@ -5,11 +5,11 @@ Departments ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletedrivegroupresponse.md b/docs/models/deletedrivegroupresponse.md index 968bbc88..08d22943 100644 --- a/docs/models/deletedrivegroupresponse.md +++ b/docs/models/deletedrivegroupresponse.md @@ -5,11 +5,11 @@ DriveGroups ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletedriveresponse.md b/docs/models/deletedriveresponse.md index 1ef014aa..04cfe305 100644 --- a/docs/models/deletedriveresponse.md +++ b/docs/models/deletedriveresponse.md @@ -5,11 +5,11 @@ Drives ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteemployeeresponse.md b/docs/models/deleteemployeeresponse.md index 8baab2c9..a23d7d74 100644 --- a/docs/models/deleteemployeeresponse.md +++ b/docs/models/deleteemployeeresponse.md @@ -5,11 +5,11 @@ Employees ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteexpenseresponse.md b/docs/models/deleteexpenseresponse.md index a843b640..5916ff82 100644 --- a/docs/models/deleteexpenseresponse.md +++ b/docs/models/deleteexpenseresponse.md @@ -5,11 +5,11 @@ Expenses ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletefileresponse.md b/docs/models/deletefileresponse.md index 7e88fab9..3fd04cf4 100644 --- a/docs/models/deletefileresponse.md +++ b/docs/models/deletefileresponse.md @@ -5,11 +5,11 @@ Files ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletefolderresponse.md b/docs/models/deletefolderresponse.md index 8146eb9e..d3181560 100644 --- a/docs/models/deletefolderresponse.md +++ b/docs/models/deletefolderresponse.md @@ -5,11 +5,11 @@ Folders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletehriscompanyresponse.md b/docs/models/deletehriscompanyresponse.md index 98e0ef30..32d38175 100644 --- a/docs/models/deletehriscompanyresponse.md +++ b/docs/models/deletehriscompanyresponse.md @@ -5,11 +5,11 @@ Companies ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletejournalentryresponse.md b/docs/models/deletejournalentryresponse.md index 12ca7c3f..d10d41ae 100644 --- a/docs/models/deletejournalentryresponse.md +++ b/docs/models/deletejournalentryresponse.md @@ -5,11 +5,11 @@ JournalEntries ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteleadresponse.md b/docs/models/deleteleadresponse.md index 3a71a89e..e8f27b05 100644 --- a/docs/models/deleteleadresponse.md +++ b/docs/models/deleteleadresponse.md @@ -5,11 +5,11 @@ Lead deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteledgeraccountresponse.md b/docs/models/deleteledgeraccountresponse.md index 96b19063..47c4c379 100644 --- a/docs/models/deleteledgeraccountresponse.md +++ b/docs/models/deleteledgeraccountresponse.md @@ -5,11 +5,11 @@ LedgerAccount deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletemessageresponse.md b/docs/models/deletemessageresponse.md index 7115a505..ca5a6f17 100644 --- a/docs/models/deletemessageresponse.md +++ b/docs/models/deletemessageresponse.md @@ -5,11 +5,11 @@ Messages ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletenoteresponse.md b/docs/models/deletenoteresponse.md index 1786b8b8..7ea3af1f 100644 --- a/docs/models/deletenoteresponse.md +++ b/docs/models/deletenoteresponse.md @@ -5,11 +5,11 @@ Note deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteopportunityresponse.md b/docs/models/deleteopportunityresponse.md index e9a3368a..ce041a5c 100644 --- a/docs/models/deleteopportunityresponse.md +++ b/docs/models/deleteopportunityresponse.md @@ -5,11 +5,11 @@ Opportunity deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletepaymentresponse.md b/docs/models/deletepaymentresponse.md index 971f1dca..62c97338 100644 --- a/docs/models/deletepaymentresponse.md +++ b/docs/models/deletepaymentresponse.md @@ -5,11 +5,11 @@ Payment deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletepurchaseorderresponse.md b/docs/models/deletepurchaseorderresponse.md index 9157f2e4..83e97dae 100644 --- a/docs/models/deletepurchaseorderresponse.md +++ b/docs/models/deletepurchaseorderresponse.md @@ -5,11 +5,11 @@ PurchaseOrders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletesharedlinkresponse.md b/docs/models/deletesharedlinkresponse.md index a4ed230a..32005609 100644 --- a/docs/models/deletesharedlinkresponse.md +++ b/docs/models/deletesharedlinkresponse.md @@ -5,11 +5,11 @@ Shared Links ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletesubsidiaryresponse.md b/docs/models/deletesubsidiaryresponse.md index 1ebac63d..77430683 100644 --- a/docs/models/deletesubsidiaryresponse.md +++ b/docs/models/deletesubsidiaryresponse.md @@ -5,11 +5,11 @@ Subsidiarys ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletesupplierresponse.md b/docs/models/deletesupplierresponse.md index 4e2874fb..33aec841 100644 --- a/docs/models/deletesupplierresponse.md +++ b/docs/models/deletesupplierresponse.md @@ -5,11 +5,11 @@ Supplier deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | suppliers | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | suppliers | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletetaxrateresponse.md b/docs/models/deletetaxrateresponse.md index 864f31d3..817050f9 100644 --- a/docs/models/deletetaxrateresponse.md +++ b/docs/models/deletetaxrateresponse.md @@ -5,11 +5,11 @@ TaxRates deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteticketresponse.md b/docs/models/deleteticketresponse.md index 04b241a0..0c83b52c 100644 --- a/docs/models/deleteticketresponse.md +++ b/docs/models/deleteticketresponse.md @@ -5,11 +5,11 @@ Delete a Ticket ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | add | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | jira | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | add | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletetimeoffrequestresponse.md b/docs/models/deletetimeoffrequestresponse.md index 3d262a8f..d7fac2fa 100644 --- a/docs/models/deletetimeoffrequestresponse.md +++ b/docs/models/deletetimeoffrequestresponse.md @@ -5,11 +5,11 @@ TimeOffRequests ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deletetrackingcategoryresponse.md b/docs/models/deletetrackingcategoryresponse.md index 0a65cbac..cb4cc3cd 100644 --- a/docs/models/deletetrackingcategoryresponse.md +++ b/docs/models/deletetrackingcategoryresponse.md @@ -5,11 +5,11 @@ Tracking category deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteuploadsessionresponse.md b/docs/models/deleteuploadsessionresponse.md index b3e41734..065da993 100644 --- a/docs/models/deleteuploadsessionresponse.md +++ b/docs/models/deleteuploadsessionresponse.md @@ -5,11 +5,11 @@ UploadSessions ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | UploadSessions | -| `operation` | *str* | :heavy_check_mark: | Operation performed | one | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | UploadSessions | +| `operation` | *str* | :heavy_check_mark: | Operation performed | one | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/deleteuserresponse.md b/docs/models/deleteuserresponse.md index 36f247de..3ec5461b 100644 --- a/docs/models/deleteuserresponse.md +++ b/docs/models/deleteuserresponse.md @@ -5,11 +5,11 @@ User deleted ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | users | -| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | users | +| `operation` | *str* | :heavy_check_mark: | Operation performed | delete | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/ecommercecustomersallrequest.md b/docs/models/ecommercecustomersallrequest.md index 87483c0e..b530db5a 100644 --- a/docs/models/ecommercecustomersallrequest.md +++ b/docs/models/ecommercecustomersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/ecommercecustomersonerequest.md b/docs/models/ecommercecustomersonerequest.md index 95e9255e..c64f90d8 100644 --- a/docs/models/ecommercecustomersonerequest.md +++ b/docs/models/ecommercecustomersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/ecommerceordersallrequest.md b/docs/models/ecommerceordersallrequest.md index 9dcf7024..81d2009b 100644 --- a/docs/models/ecommerceordersallrequest.md +++ b/docs/models/ecommerceordersallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/ecommerceordersonerequest.md b/docs/models/ecommerceordersonerequest.md index 56ae2358..ec015082 100644 --- a/docs/models/ecommerceordersonerequest.md +++ b/docs/models/ecommerceordersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/ecommerceproductsallrequest.md b/docs/models/ecommerceproductsallrequest.md index f8d4f3cb..74dfb537 100644 --- a/docs/models/ecommerceproductsallrequest.md +++ b/docs/models/ecommerceproductsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/ecommerceproductsonerequest.md b/docs/models/ecommerceproductsonerequest.md index 7ea704fe..d1cd9355 100644 --- a/docs/models/ecommerceproductsonerequest.md +++ b/docs/models/ecommerceproductsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/ecommercestoresonerequest.md b/docs/models/ecommercestoresonerequest.md index db8b40aa..25625469 100644 --- a/docs/models/ecommercestoresonerequest.md +++ b/docs/models/ecommercestoresonerequest.md @@ -5,6 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsaddrequest.md b/docs/models/filestoragedrivegroupsaddrequest.md index a44f1067..d17febef 100644 --- a/docs/models/filestoragedrivegroupsaddrequest.md +++ b/docs/models/filestoragedrivegroupsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsallrequest.md b/docs/models/filestoragedrivegroupsallrequest.md index 2dcd1cb6..7bb4930f 100644 --- a/docs/models/filestoragedrivegroupsallrequest.md +++ b/docs/models/filestoragedrivegroupsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/filestoragedrivegroupsdeleterequest.md b/docs/models/filestoragedrivegroupsdeleterequest.md index 40e5caaf..6133f606 100644 --- a/docs/models/filestoragedrivegroupsdeleterequest.md +++ b/docs/models/filestoragedrivegroupsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsonerequest.md b/docs/models/filestoragedrivegroupsonerequest.md index 4dd92d6c..6b75a8a8 100644 --- a/docs/models/filestoragedrivegroupsonerequest.md +++ b/docs/models/filestoragedrivegroupsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragedrivegroupsupdaterequest.md b/docs/models/filestoragedrivegroupsupdaterequest.md index 4b5da06a..eaf70d57 100644 --- a/docs/models/filestoragedrivegroupsupdaterequest.md +++ b/docs/models/filestoragedrivegroupsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `drive_group` | [models.DriveGroupInput](../models/drivegroupinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragedrivesaddrequest.md b/docs/models/filestoragedrivesaddrequest.md index fdba8144..973a8d75 100644 --- a/docs/models/filestoragedrivesaddrequest.md +++ b/docs/models/filestoragedrivesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/filestoragedrivesallrequest.md b/docs/models/filestoragedrivesallrequest.md index 65ea039b..ef90ce1d 100644 --- a/docs/models/filestoragedrivesallrequest.md +++ b/docs/models/filestoragedrivesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/filestoragedrivesdeleterequest.md b/docs/models/filestoragedrivesdeleterequest.md index 348a9ae5..6d168b32 100644 --- a/docs/models/filestoragedrivesdeleterequest.md +++ b/docs/models/filestoragedrivesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragedrivesonerequest.md b/docs/models/filestoragedrivesonerequest.md index 5ad054de..1252cec1 100644 --- a/docs/models/filestoragedrivesonerequest.md +++ b/docs/models/filestoragedrivesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragedrivesupdaterequest.md b/docs/models/filestoragedrivesupdaterequest.md index d723accc..920d6bb7 100644 --- a/docs/models/filestoragedrivesupdaterequest.md +++ b/docs/models/filestoragedrivesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `drive` | [models.DriveInput](../models/driveinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragefilesallrequest.md b/docs/models/filestoragefilesallrequest.md index 2b64cfc1..86fdeb39 100644 --- a/docs/models/filestoragefilesallrequest.md +++ b/docs/models/filestoragefilesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/filestoragefilesdeleterequest.md b/docs/models/filestoragefilesdeleterequest.md index df2a0978..5e1c00c9 100644 --- a/docs/models/filestoragefilesdeleterequest.md +++ b/docs/models/filestoragefilesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragefilesdownloadrequest.md b/docs/models/filestoragefilesdownloadrequest.md index 2d05a8d6..8d4f89a2 100644 --- a/docs/models/filestoragefilesdownloadrequest.md +++ b/docs/models/filestoragefilesdownloadrequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefilesexportrequest.md b/docs/models/filestoragefilesexportrequest.md index 1d9252cf..ba80a545 100644 --- a/docs/models/filestoragefilesexportrequest.md +++ b/docs/models/filestoragefilesexportrequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefilesonerequest.md b/docs/models/filestoragefilesonerequest.md index 9db2ec80..129706a0 100644 --- a/docs/models/filestoragefilesonerequest.md +++ b/docs/models/filestoragefilesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefilessearchrequest.md b/docs/models/filestoragefilessearchrequest.md index b757c812..f6cbc76b 100644 --- a/docs/models/filestoragefilessearchrequest.md +++ b/docs/models/filestoragefilessearchrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `files_search` | [models.FilesSearch](../models/filessearch.md) | :heavy_check_mark: | N/A | {
"query": "logo jpg"
} | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through_param` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/models/filestoragefilesupdaterequest.md b/docs/models/filestoragefilesupdaterequest.md index 6a7d2623..aa0d0da8 100644 --- a/docs/models/filestoragefilesupdaterequest.md +++ b/docs/models/filestoragefilesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `update_file_request` | [models.UpdateFileRequest](../models/updatefilerequest.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragefoldersaddrequest.md b/docs/models/filestoragefoldersaddrequest.md index bcda3360..df4f0324 100644 --- a/docs/models/filestoragefoldersaddrequest.md +++ b/docs/models/filestoragefoldersaddrequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create_folder_request` | [models.CreateFolderRequest](../models/createfolderrequest.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefolderscopyrequest.md b/docs/models/filestoragefolderscopyrequest.md index 4cf76e31..2fbb3c4f 100644 --- a/docs/models/filestoragefolderscopyrequest.md +++ b/docs/models/filestoragefolderscopyrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `copy_folder_request` | [models.CopyFolderRequest](../models/copyfolderrequest.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefoldersdeleterequest.md b/docs/models/filestoragefoldersdeleterequest.md index 24936fc1..0e1d500b 100644 --- a/docs/models/filestoragefoldersdeleterequest.md +++ b/docs/models/filestoragefoldersdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragefoldersonerequest.md b/docs/models/filestoragefoldersonerequest.md index d21a487c..0bea9ed1 100644 --- a/docs/models/filestoragefoldersonerequest.md +++ b/docs/models/filestoragefoldersonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragefoldersupdaterequest.md b/docs/models/filestoragefoldersupdaterequest.md index 136c94cc..26f2b019 100644 --- a/docs/models/filestoragefoldersupdaterequest.md +++ b/docs/models/filestoragefoldersupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `update_folder_request` | [models.UpdateFolderRequest](../models/updatefolderrequest.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksaddrequest.md b/docs/models/filestoragesharedlinksaddrequest.md index 0fcc14a0..aed06087 100644 --- a/docs/models/filestoragesharedlinksaddrequest.md +++ b/docs/models/filestoragesharedlinksaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksallrequest.md b/docs/models/filestoragesharedlinksallrequest.md index 96981bf0..735b9744 100644 --- a/docs/models/filestoragesharedlinksallrequest.md +++ b/docs/models/filestoragesharedlinksallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/filestoragesharedlinksdeleterequest.md b/docs/models/filestoragesharedlinksdeleterequest.md index 31e0e9db..ae3493ab 100644 --- a/docs/models/filestoragesharedlinksdeleterequest.md +++ b/docs/models/filestoragesharedlinksdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksonerequest.md b/docs/models/filestoragesharedlinksonerequest.md index f522f9ea..4d2b98cc 100644 --- a/docs/models/filestoragesharedlinksonerequest.md +++ b/docs/models/filestoragesharedlinksonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/filestoragesharedlinksupdaterequest.md b/docs/models/filestoragesharedlinksupdaterequest.md index 3a1b6971..9da237c9 100644 --- a/docs/models/filestoragesharedlinksupdaterequest.md +++ b/docs/models/filestoragesharedlinksupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `shared_link` | [models.SharedLinkInput](../models/sharedlinkinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsaddrequest.md b/docs/models/filestorageuploadsessionsaddrequest.md index fb5d3bf4..72a87261 100644 --- a/docs/models/filestorageuploadsessionsaddrequest.md +++ b/docs/models/filestorageuploadsessionsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `create_upload_session_request` | [models.CreateUploadSessionRequest](../models/createuploadsessionrequest.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsdeleterequest.md b/docs/models/filestorageuploadsessionsdeleterequest.md index ee87e1e3..d5240730 100644 --- a/docs/models/filestorageuploadsessionsdeleterequest.md +++ b/docs/models/filestorageuploadsessionsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsfinishrequest.md b/docs/models/filestorageuploadsessionsfinishrequest.md index 23caf34d..5b646015 100644 --- a/docs/models/filestorageuploadsessionsfinishrequest.md +++ b/docs/models/filestorageuploadsessionsfinishrequest.md @@ -7,6 +7,8 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `digest` | *Optional[str]* | :heavy_minus_sign: | The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) | sha=fpRyg5eVQletdZqEKaFlqwBXJzM= | | `request_body` | [Optional[models.FileStorageUploadSessionsFinishRequestBody]](../models/filestorageuploadsessionsfinishrequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/filestorageuploadsessionsonerequest.md b/docs/models/filestorageuploadsessionsonerequest.md index 9c048b06..70550e83 100644 --- a/docs/models/filestorageuploadsessionsonerequest.md +++ b/docs/models/filestorageuploadsessionsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hriscompaniesaddrequest.md b/docs/models/hriscompaniesaddrequest.md index 4d7cf26c..6061def9 100644 --- a/docs/models/hriscompaniesaddrequest.md +++ b/docs/models/hriscompaniesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/hriscompaniesallrequest.md b/docs/models/hriscompaniesallrequest.md index 061fc4ee..59462afe 100644 --- a/docs/models/hriscompaniesallrequest.md +++ b/docs/models/hriscompaniesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/hriscompaniesdeleterequest.md b/docs/models/hriscompaniesdeleterequest.md index 298c2010..380ebcc8 100644 --- a/docs/models/hriscompaniesdeleterequest.md +++ b/docs/models/hriscompaniesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hriscompaniesonerequest.md b/docs/models/hriscompaniesonerequest.md index dab3ae92..a01d31c9 100644 --- a/docs/models/hriscompaniesonerequest.md +++ b/docs/models/hriscompaniesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hriscompaniesupdaterequest.md b/docs/models/hriscompaniesupdaterequest.md index 826e1687..f59e5102 100644 --- a/docs/models/hriscompaniesupdaterequest.md +++ b/docs/models/hriscompaniesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `hris_company` | [models.HrisCompanyInput](../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hrisdepartmentsaddrequest.md b/docs/models/hrisdepartmentsaddrequest.md index c42ae64a..94ef7b20 100644 --- a/docs/models/hrisdepartmentsaddrequest.md +++ b/docs/models/hrisdepartmentsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/hrisdepartmentsallrequest.md b/docs/models/hrisdepartmentsallrequest.md index 97985f0e..7eb1a092 100644 --- a/docs/models/hrisdepartmentsallrequest.md +++ b/docs/models/hrisdepartmentsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/hrisdepartmentsdeleterequest.md b/docs/models/hrisdepartmentsdeleterequest.md index f4067a0c..19b664e4 100644 --- a/docs/models/hrisdepartmentsdeleterequest.md +++ b/docs/models/hrisdepartmentsdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hrisdepartmentsonerequest.md b/docs/models/hrisdepartmentsonerequest.md index 7e1addf4..446f9f0a 100644 --- a/docs/models/hrisdepartmentsonerequest.md +++ b/docs/models/hrisdepartmentsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hrisdepartmentsupdaterequest.md b/docs/models/hrisdepartmentsupdaterequest.md index d86590a1..c1772a59 100644 --- a/docs/models/hrisdepartmentsupdaterequest.md +++ b/docs/models/hrisdepartmentsupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `department` | [models.DepartmentInput](../models/departmentinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hrisemployeepayrollsallrequest.md b/docs/models/hrisemployeepayrollsallrequest.md index 65b23cfd..f042784d 100644 --- a/docs/models/hrisemployeepayrollsallrequest.md +++ b/docs/models/hrisemployeepayrollsallrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.PayrollsFilter]](../models/payrollsfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2022-04-08",
"end_date": "2022-04-21"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/hrisemployeepayrollsonerequest.md b/docs/models/hrisemployeepayrollsonerequest.md index ead0ba1d..f807edcb 100644 --- a/docs/models/hrisemployeepayrollsonerequest.md +++ b/docs/models/hrisemployeepayrollsonerequest.md @@ -8,5 +8,7 @@ | `payroll_id` | *str* | :heavy_check_mark: | ID of the payroll you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hrisemployeesaddrequest.md b/docs/models/hrisemployeesaddrequest.md index 72ba7385..7c77b1eb 100644 --- a/docs/models/hrisemployeesaddrequest.md +++ b/docs/models/hrisemployeesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/hrisemployeesallrequest.md b/docs/models/hrisemployeesallrequest.md index 82edf6b7..f5b40598 100644 --- a/docs/models/hrisemployeesallrequest.md +++ b/docs/models/hrisemployeesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/hrisemployeeschedulesallrequest.md b/docs/models/hrisemployeeschedulesallrequest.md index 880c487b..a841574d 100644 --- a/docs/models/hrisemployeeschedulesallrequest.md +++ b/docs/models/hrisemployeeschedulesallrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hrisemployeesdeleterequest.md b/docs/models/hrisemployeesdeleterequest.md index 03bd7310..16757a12 100644 --- a/docs/models/hrisemployeesdeleterequest.md +++ b/docs/models/hrisemployeesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hrisemployeesonerequest.md b/docs/models/hrisemployeesonerequest.md index 1e2d2568..8e4d92ab 100644 --- a/docs/models/hrisemployeesonerequest.md +++ b/docs/models/hrisemployeesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/models/hrisemployeesupdaterequest.md b/docs/models/hrisemployeesupdaterequest.md index 9c41c58f..cbb58689 100644 --- a/docs/models/hrisemployeesupdaterequest.md +++ b/docs/models/hrisemployeesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hrispayrollsallrequest.md b/docs/models/hrispayrollsallrequest.md index 44263d02..3d667a53 100644 --- a/docs/models/hrispayrollsallrequest.md +++ b/docs/models/hrispayrollsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.PayrollsFilter]](../models/payrollsfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2022-04-08",
"end_date": "2022-04-21"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/models/hrispayrollsonerequest.md b/docs/models/hrispayrollsonerequest.md index 1120ec9c..1381e05e 100644 --- a/docs/models/hrispayrollsonerequest.md +++ b/docs/models/hrispayrollsonerequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `payroll_id` | *str* | :heavy_check_mark: | ID of the payroll you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsaddrequest.md b/docs/models/hristimeoffrequestsaddrequest.md index 499b63d9..b59f0737 100644 --- a/docs/models/hristimeoffrequestsaddrequest.md +++ b/docs/models/hristimeoffrequestsaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsallrequest.md b/docs/models/hristimeoffrequestsallrequest.md index 50d86c47..fcad51ec 100644 --- a/docs/models/hristimeoffrequestsallrequest.md +++ b/docs/models/hristimeoffrequestsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/hristimeoffrequestsdeleterequest.md b/docs/models/hristimeoffrequestsdeleterequest.md index b22dd613..2c45fc3c 100644 --- a/docs/models/hristimeoffrequestsdeleterequest.md +++ b/docs/models/hristimeoffrequestsdeleterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsonerequest.md b/docs/models/hristimeoffrequestsonerequest.md index 3c5e33f7..70d49da9 100644 --- a/docs/models/hristimeoffrequestsonerequest.md +++ b/docs/models/hristimeoffrequestsonerequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/hristimeoffrequestsupdaterequest.md b/docs/models/hristimeoffrequestsupdaterequest.md index db0d0a7a..4a94875a 100644 --- a/docs/models/hristimeoffrequestsupdaterequest.md +++ b/docs/models/hristimeoffrequestsupdaterequest.md @@ -8,5 +8,7 @@ | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id_param` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionsallrequest.md b/docs/models/issuetrackingcollectionsallrequest.md index 757c8596..d4f82811 100644 --- a/docs/models/issuetrackingcollectionsallrequest.md +++ b/docs/models/issuetrackingcollectionsallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionsonerequest.md b/docs/models/issuetrackingcollectionsonerequest.md index ebabc900..2eca057c 100644 --- a/docs/models/issuetrackingcollectionsonerequest.md +++ b/docs/models/issuetrackingcollectionsonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectiontagsallrequest.md b/docs/models/issuetrackingcollectiontagsallrequest.md index 8aef3cd3..df3b33f5 100644 --- a/docs/models/issuetrackingcollectiontagsallrequest.md +++ b/docs/models/issuetrackingcollectiontagsallrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionticketcommentsaddrequest.md b/docs/models/issuetrackingcollectionticketcommentsaddrequest.md index 2fd9edec..33ec18b5 100644 --- a/docs/models/issuetrackingcollectionticketcommentsaddrequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsaddrequest.md @@ -9,4 +9,6 @@ | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsallrequest.md b/docs/models/issuetrackingcollectionticketcommentsallrequest.md index ecac8f6d..b0a182df 100644 --- a/docs/models/issuetrackingcollectionticketcommentsallrequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsallrequest.md @@ -8,6 +8,8 @@ | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md b/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md index 6b8adb39..4d78b0e3 100644 --- a/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsdeleterequest.md @@ -8,5 +8,7 @@ | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketcommentsonerequest.md b/docs/models/issuetrackingcollectionticketcommentsonerequest.md index 88341c67..03336bb4 100644 --- a/docs/models/issuetrackingcollectionticketcommentsonerequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsonerequest.md @@ -9,6 +9,8 @@ | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md b/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md index c1706652..c8f56fa5 100644 --- a/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md +++ b/docs/models/issuetrackingcollectionticketcommentsupdaterequest.md @@ -9,5 +9,7 @@ | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_ticket_comment` | [models.CollectionTicketCommentInput](../models/collectionticketcommentinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsaddrequest.md b/docs/models/issuetrackingcollectionticketsaddrequest.md index f58d986b..0a0a6b8c 100644 --- a/docs/models/issuetrackingcollectionticketsaddrequest.md +++ b/docs/models/issuetrackingcollectionticketsaddrequest.md @@ -8,4 +8,6 @@ | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsallrequest.md b/docs/models/issuetrackingcollectionticketsallrequest.md index bb282256..fafba79b 100644 --- a/docs/models/issuetrackingcollectionticketsallrequest.md +++ b/docs/models/issuetrackingcollectionticketsallrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionticketsdeleterequest.md b/docs/models/issuetrackingcollectionticketsdeleterequest.md index dda69ff2..f2c39c71 100644 --- a/docs/models/issuetrackingcollectionticketsdeleterequest.md +++ b/docs/models/issuetrackingcollectionticketsdeleterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsonerequest.md b/docs/models/issuetrackingcollectionticketsonerequest.md index 90a02bba..c5afad12 100644 --- a/docs/models/issuetrackingcollectionticketsonerequest.md +++ b/docs/models/issuetrackingcollectionticketsonerequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionticketsupdaterequest.md b/docs/models/issuetrackingcollectionticketsupdaterequest.md index 2df56459..ca708d02 100644 --- a/docs/models/issuetrackingcollectionticketsupdaterequest.md +++ b/docs/models/issuetrackingcollectionticketsupdaterequest.md @@ -8,5 +8,7 @@ | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket` | [models.TicketInput](../models/ticketinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/issuetrackingcollectionusersallrequest.md b/docs/models/issuetrackingcollectionusersallrequest.md index ae0b4bf3..8857447b 100644 --- a/docs/models/issuetrackingcollectionusersallrequest.md +++ b/docs/models/issuetrackingcollectionusersallrequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/issuetrackingcollectionusersonerequest.md b/docs/models/issuetrackingcollectionusersonerequest.md index 9d55a053..e37a3cd8 100644 --- a/docs/models/issuetrackingcollectionusersonerequest.md +++ b/docs/models/issuetrackingcollectionusersonerequest.md @@ -7,6 +7,8 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/smsmessagesaddrequest.md b/docs/models/smsmessagesaddrequest.md index 9e515226..e4b87a66 100644 --- a/docs/models/smsmessagesaddrequest.md +++ b/docs/models/smsmessagesaddrequest.md @@ -7,4 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | \ No newline at end of file diff --git a/docs/models/smsmessagesallrequest.md b/docs/models/smsmessagesallrequest.md index 2dc07748..e5853307 100644 --- a/docs/models/smsmessagesallrequest.md +++ b/docs/models/smsmessagesallrequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/models/smsmessagesdeleterequest.md b/docs/models/smsmessagesdeleterequest.md index e49cccef..e892430e 100644 --- a/docs/models/smsmessagesdeleterequest.md +++ b/docs/models/smsmessagesdeleterequest.md @@ -6,5 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/smsmessagesonerequest.md b/docs/models/smsmessagesonerequest.md index 6acda1dd..8af39814 100644 --- a/docs/models/smsmessagesonerequest.md +++ b/docs/models/smsmessagesonerequest.md @@ -6,6 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/smsmessagesupdaterequest.md b/docs/models/smsmessagesupdaterequest.md index d2cbfd48..805b2963 100644 --- a/docs/models/smsmessagesupdaterequest.md +++ b/docs/models/smsmessagesupdaterequest.md @@ -7,5 +7,7 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `message` | [models.MessageInput](../models/messageinput.md) | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/unifiedid.md b/docs/models/unifiedid.md index 8ebead54..ccaa654e 100644 --- a/docs/models/unifiedid.md +++ b/docs/models/unifiedid.md @@ -1,5 +1,7 @@ # UnifiedID +A object containing a unique identifier for the resource that was created, updated, or deleted. + ## Fields diff --git a/docs/models/updateaccountingdepartmentresponse.md b/docs/models/updateaccountingdepartmentresponse.md index 5a94e327..45df6531 100644 --- a/docs/models/updateaccountingdepartmentresponse.md +++ b/docs/models/updateaccountingdepartmentresponse.md @@ -5,11 +5,11 @@ Department ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateaccountinglocationresponse.md b/docs/models/updateaccountinglocationresponse.md index 5eba5f94..0502076e 100644 --- a/docs/models/updateaccountinglocationresponse.md +++ b/docs/models/updateaccountinglocationresponse.md @@ -5,11 +5,11 @@ Location ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | locations | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateactivityresponse.md b/docs/models/updateactivityresponse.md index 2cf354f2..45a24693 100644 --- a/docs/models/updateactivityresponse.md +++ b/docs/models/updateactivityresponse.md @@ -5,11 +5,11 @@ Activity updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | activities | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateapplicantresponse.md b/docs/models/updateapplicantresponse.md index f12b03c5..6fce5f39 100644 --- a/docs/models/updateapplicantresponse.md +++ b/docs/models/updateapplicantresponse.md @@ -5,11 +5,11 @@ Applicants ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | lever | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applicants | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateapplicationresponse.md b/docs/models/updateapplicationresponse.md index 00a79683..d552ec6b 100644 --- a/docs/models/updateapplicationresponse.md +++ b/docs/models/updateapplicationresponse.md @@ -5,11 +5,11 @@ Applications ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sap-successfactors | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Applications | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatebillpaymentresponse.md b/docs/models/updatebillpaymentresponse.md index 4f503755..a89cbb13 100644 --- a/docs/models/updatebillpaymentresponse.md +++ b/docs/models/updatebillpaymentresponse.md @@ -5,11 +5,11 @@ Bill Payment updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatebillresponse.md b/docs/models/updatebillresponse.md index ff5a8300..3e64e609 100644 --- a/docs/models/updatebillresponse.md +++ b/docs/models/updatebillresponse.md @@ -5,11 +5,11 @@ Bill Updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | bills | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatecommentresponse.md b/docs/models/updatecommentresponse.md index 78bf45e7..b93e3bc1 100644 --- a/docs/models/updatecommentresponse.md +++ b/docs/models/updatecommentresponse.md @@ -5,11 +5,11 @@ Update a Comment ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | github | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | github | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatecompanyresponse.md b/docs/models/updatecompanyresponse.md index 12f3ba00..444a5596 100644 --- a/docs/models/updatecompanyresponse.md +++ b/docs/models/updatecompanyresponse.md @@ -5,11 +5,11 @@ Company updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatecontactresponse.md b/docs/models/updatecontactresponse.md index dbe68466..564c5119 100644 --- a/docs/models/updatecontactresponse.md +++ b/docs/models/updatecontactresponse.md @@ -5,11 +5,11 @@ Contact updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | contacts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatecreditnoteresponse.md b/docs/models/updatecreditnoteresponse.md index 1ab01ad6..59057cef 100644 --- a/docs/models/updatecreditnoteresponse.md +++ b/docs/models/updatecreditnoteresponse.md @@ -5,11 +5,11 @@ Credit Note updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | credit-notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatecustomerresponse.md b/docs/models/updatecustomerresponse.md index 2e4b4bd1..58bcce8a 100644 --- a/docs/models/updatecustomerresponse.md +++ b/docs/models/updatecustomerresponse.md @@ -5,11 +5,11 @@ Customers ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | customers | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatedepartmentresponse.md b/docs/models/updatedepartmentresponse.md index e4f6f02c..1e3792b7 100644 --- a/docs/models/updatedepartmentresponse.md +++ b/docs/models/updatedepartmentresponse.md @@ -5,11 +5,11 @@ Departments ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | workday | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Departments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatedrivegroupresponse.md b/docs/models/updatedrivegroupresponse.md index 452cd1d4..5477244f 100644 --- a/docs/models/updatedrivegroupresponse.md +++ b/docs/models/updatedrivegroupresponse.md @@ -5,11 +5,11 @@ DriveGroups ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | DriveGroups | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatedriveresponse.md b/docs/models/updatedriveresponse.md index d7e3a842..80cfd8c2 100644 --- a/docs/models/updatedriveresponse.md +++ b/docs/models/updatedriveresponse.md @@ -5,11 +5,11 @@ Drives ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Drives | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateemployeeresponse.md b/docs/models/updateemployeeresponse.md index 6610bd02..cc7e63a4 100644 --- a/docs/models/updateemployeeresponse.md +++ b/docs/models/updateemployeeresponse.md @@ -5,11 +5,11 @@ Employees ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | sage-hr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Employees | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateexpenseresponse.md b/docs/models/updateexpenseresponse.md index 2a52c63d..cbb3b041 100644 --- a/docs/models/updateexpenseresponse.md +++ b/docs/models/updateexpenseresponse.md @@ -5,11 +5,11 @@ Expenses ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Expenses | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatefileresponse.md b/docs/models/updatefileresponse.md index 29813dce..2333f753 100644 --- a/docs/models/updatefileresponse.md +++ b/docs/models/updatefileresponse.md @@ -5,11 +5,11 @@ Files ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | google-drive | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | files | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatefolderresponse.md b/docs/models/updatefolderresponse.md index dcfb1ada..ab00c982 100644 --- a/docs/models/updatefolderresponse.md +++ b/docs/models/updatefolderresponse.md @@ -5,11 +5,11 @@ Folders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Folders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatehriscompanyresponse.md b/docs/models/updatehriscompanyresponse.md index 7adf9aaf..ef1d3ce5 100644 --- a/docs/models/updatehriscompanyresponse.md +++ b/docs/models/updatehriscompanyresponse.md @@ -5,11 +5,11 @@ Companies ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | undefined | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateinvoiceitemsresponse.md b/docs/models/updateinvoiceitemsresponse.md index 5227ed49..5d1d5095 100644 --- a/docs/models/updateinvoiceitemsresponse.md +++ b/docs/models/updateinvoiceitemsresponse.md @@ -5,11 +5,11 @@ InvoiceItems ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | invoice-items | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | invoice-items | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatejournalentryresponse.md b/docs/models/updatejournalentryresponse.md index 51360500..517805db 100644 --- a/docs/models/updatejournalentryresponse.md +++ b/docs/models/updatejournalentryresponse.md @@ -5,11 +5,11 @@ JournalEntries ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | journal-entries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateleadresponse.md b/docs/models/updateleadresponse.md index 585fd81e..a8c6c5f0 100644 --- a/docs/models/updateleadresponse.md +++ b/docs/models/updateleadresponse.md @@ -5,11 +5,11 @@ Lead updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateledgeraccountresponse.md b/docs/models/updateledgeraccountresponse.md index 702dd178..3b8c9f65 100644 --- a/docs/models/updateledgeraccountresponse.md +++ b/docs/models/updateledgeraccountresponse.md @@ -5,11 +5,11 @@ LedgerAccount updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | ledger-accounts | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatemessageresponse.md b/docs/models/updatemessageresponse.md index 8a5bc609..6a6b3529 100644 --- a/docs/models/updatemessageresponse.md +++ b/docs/models/updatemessageresponse.md @@ -5,11 +5,11 @@ Messages ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | twilio | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Messages | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatenoteresponse.md b/docs/models/updatenoteresponse.md index 1d8baa0e..13cfc516 100644 --- a/docs/models/updatenoteresponse.md +++ b/docs/models/updatenoteresponse.md @@ -5,11 +5,11 @@ Note updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | notes | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateopportunityresponse.md b/docs/models/updateopportunityresponse.md index a5ae2135..0997a155 100644 --- a/docs/models/updateopportunityresponse.md +++ b/docs/models/updateopportunityresponse.md @@ -5,11 +5,11 @@ Opportunity updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatepaymentresponse.md b/docs/models/updatepaymentresponse.md index 2c0b4736..6c6afb7e 100644 --- a/docs/models/updatepaymentresponse.md +++ b/docs/models/updatepaymentresponse.md @@ -5,11 +5,11 @@ Payment Updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | payments | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatepurchaseorderresponse.md b/docs/models/updatepurchaseorderresponse.md index 1b09304e..1acab33c 100644 --- a/docs/models/updatepurchaseorderresponse.md +++ b/docs/models/updatepurchaseorderresponse.md @@ -5,11 +5,11 @@ PurchaseOrders ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | PurchaseOrders | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatesharedlinkresponse.md b/docs/models/updatesharedlinkresponse.md index 316f8974..027f4a45 100644 --- a/docs/models/updatesharedlinkresponse.md +++ b/docs/models/updatesharedlinkresponse.md @@ -5,11 +5,11 @@ Shared Links ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | dropbox | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Shared Links | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatesubsidiaryresponse.md b/docs/models/updatesubsidiaryresponse.md index 07946fe0..e88c8016 100644 --- a/docs/models/updatesubsidiaryresponse.md +++ b/docs/models/updatesubsidiaryresponse.md @@ -5,11 +5,11 @@ Subsidiaries ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | subsidiaries | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatesupplierresponse.md b/docs/models/updatesupplierresponse.md index c9c206ad..94b09670 100644 --- a/docs/models/updatesupplierresponse.md +++ b/docs/models/updatesupplierresponse.md @@ -5,11 +5,11 @@ Supplier updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | suppliers | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | suppliers | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatetaxrateresponse.md b/docs/models/updatetaxrateresponse.md index 5a1cf482..81156979 100644 --- a/docs/models/updatetaxrateresponse.md +++ b/docs/models/updatetaxrateresponse.md @@ -5,11 +5,11 @@ TaxRate updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | xero | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tax-rates | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateticketresponse.md b/docs/models/updateticketresponse.md index c7a40a1e..29c130be 100644 --- a/docs/models/updateticketresponse.md +++ b/docs/models/updateticketresponse.md @@ -5,11 +5,11 @@ Update a Ticket ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | github | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | github | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | Tickets | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatetimeoffrequestresponse.md b/docs/models/updatetimeoffrequestresponse.md index 22ed157a..a5eaeac3 100644 --- a/docs/models/updatetimeoffrequestresponse.md +++ b/docs/models/updatetimeoffrequestresponse.md @@ -5,11 +5,11 @@ TimeOffRequests ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | bamboohr | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | time-off-requests | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updatetrackingcategoryresponse.md b/docs/models/updatetrackingcategoryresponse.md index 9c917dbf..ce30a253 100644 --- a/docs/models/updatetrackingcategoryresponse.md +++ b/docs/models/updatetrackingcategoryresponse.md @@ -5,11 +5,11 @@ Tracking category updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | tracking-categories | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/updateuserresponse.md b/docs/models/updateuserresponse.md index a440b9f7..0447e43f 100644 --- a/docs/models/updateuserresponse.md +++ b/docs/models/updateuserresponse.md @@ -5,11 +5,11 @@ User updated ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | -| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | -| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | -| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | -| `operation` | *str* | :heavy_check_mark: | Operation performed | update | -| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 | +| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK | +| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | zoho-crm | +| `resource` | *str* | :heavy_check_mark: | Unified API resource name | companies | +| `operation` | *str* | :heavy_check_mark: | Operation performed | update | +| `data` | [models.UnifiedID](../models/unifiedid.md) | :heavy_check_mark: | A object containing a unique identifier for the resource that was created, updated, or deleted. | | \ No newline at end of file diff --git a/docs/models/vaultconnectioncustommappingsallrequest.md b/docs/models/vaultconnectioncustommappingsallrequest.md index bcb06057..e58ff5b6 100644 --- a/docs/models/vaultconnectioncustommappingsallrequest.md +++ b/docs/models/vaultconnectioncustommappingsallrequest.md @@ -8,4 +8,6 @@ | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | \ No newline at end of file diff --git a/docs/models/vaultconnectionsallrequest.md b/docs/models/vaultconnectionsallrequest.md index 03e24cdd..af1a0922 100644 --- a/docs/models/vaultconnectionsallrequest.md +++ b/docs/models/vaultconnectionsallrequest.md @@ -5,5 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `api` | *Optional[str]* | :heavy_minus_sign: | Scope results to Unified API | crm | | `configured` | *Optional[bool]* | :heavy_minus_sign: | Scopes results to connections that have been configured or not | true | \ No newline at end of file diff --git a/docs/models/vaultconnectionsdeleterequest.md b/docs/models/vaultconnectionsdeleterequest.md index a8ae5b52..4455ec5e 100644 --- a/docs/models/vaultconnectionsdeleterequest.md +++ b/docs/models/vaultconnectionsdeleterequest.md @@ -3,7 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconnectionsettingsallrequest.md b/docs/models/vaultconnectionsettingsallrequest.md index fa318226..a4607d5d 100644 --- a/docs/models/vaultconnectionsettingsallrequest.md +++ b/docs/models/vaultconnectionsettingsallrequest.md @@ -3,8 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconnectionsettingsupdaterequest.md b/docs/models/vaultconnectionsettingsupdaterequest.md index 0fd85897..41fe6185 100644 --- a/docs/models/vaultconnectionsettingsupdaterequest.md +++ b/docs/models/vaultconnectionsettingsupdaterequest.md @@ -3,9 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | -| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconnectionsimportrequest.md b/docs/models/vaultconnectionsimportrequest.md index 0e743242..878d650a 100644 --- a/docs/models/vaultconnectionsimportrequest.md +++ b/docs/models/vaultconnectionsimportrequest.md @@ -7,4 +7,6 @@ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `connection_import_data` | [models.ConnectionImportData](../models/connectionimportdata.md) | :heavy_check_mark: | Fields that need to be persisted on the resource | | \ No newline at end of file +| `connection_import_data` | [models.ConnectionImportData](../models/connectionimportdata.md) | :heavy_check_mark: | Fields that need to be persisted on the resource | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconnectionsonerequest.md b/docs/models/vaultconnectionsonerequest.md index c8e729e3..a52244f1 100644 --- a/docs/models/vaultconnectionsonerequest.md +++ b/docs/models/vaultconnectionsonerequest.md @@ -3,7 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconnectionstokenrequest.md b/docs/models/vaultconnectionstokenrequest.md index 5dad5ded..a2dc8721 100644 --- a/docs/models/vaultconnectionstokenrequest.md +++ b/docs/models/vaultconnectionstokenrequest.md @@ -7,4 +7,6 @@ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `request_body` | [Optional[models.VaultConnectionsTokenRequestBody]](../models/vaultconnectionstokenrequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/vaultconnectionsupdaterequest.md b/docs/models/vaultconnectionsupdaterequest.md index f68d1704..031e82a7 100644 --- a/docs/models/vaultconnectionsupdaterequest.md +++ b/docs/models/vaultconnectionsupdaterequest.md @@ -3,8 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `connection` | [models.ConnectionInput](../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconsumerrequestcountsallrequest.md b/docs/models/vaultconsumerrequestcountsallrequest.md index 1ba46965..38f0f43b 100644 --- a/docs/models/vaultconsumerrequestcountsallrequest.md +++ b/docs/models/vaultconsumerrequestcountsallrequest.md @@ -7,4 +7,5 @@ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | | `start_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened after datetime | 2021-05-01T12:00:00.000Z | -| `end_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened before datetime | 2021-05-30T12:00:00.000Z | \ No newline at end of file +| `end_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened before datetime | 2021-05-30T12:00:00.000Z | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconsumersaddrequest.md b/docs/models/vaultconsumersaddrequest.md new file mode 100644 index 00000000..30fbbd0f --- /dev/null +++ b/docs/models/vaultconsumersaddrequest.md @@ -0,0 +1,9 @@ +# VaultConsumersAddRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `consumer` | [models.ConsumerInput](../models/consumerinput.md) | :heavy_check_mark: | N/A | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconsumersallrequest.md b/docs/models/vaultconsumersallrequest.md index ebc1b8f0..5e537cde 100644 --- a/docs/models/vaultconsumersallrequest.md +++ b/docs/models/vaultconsumersallrequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | \ No newline at end of file diff --git a/docs/models/vaultconsumersdeleterequest.md b/docs/models/vaultconsumersdeleterequest.md index afc5f0db..1c6921a2 100644 --- a/docs/models/vaultconsumersdeleterequest.md +++ b/docs/models/vaultconsumersdeleterequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconsumersonerequest.md b/docs/models/vaultconsumersonerequest.md index d3826ef8..3b82c6c7 100644 --- a/docs/models/vaultconsumersonerequest.md +++ b/docs/models/vaultconsumersonerequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultconsumersupdaterequest.md b/docs/models/vaultconsumersupdaterequest.md index 964404c2..95a5ba1e 100644 --- a/docs/models/vaultconsumersupdaterequest.md +++ b/docs/models/vaultconsumersupdaterequest.md @@ -6,4 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | -| `update_consumer_request` | [models.UpdateConsumerRequest](../models/updateconsumerrequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `update_consumer_request` | [models.UpdateConsumerRequest](../models/updateconsumerrequest.md) | :heavy_check_mark: | N/A | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultcreatecallbackstaterequest.md b/docs/models/vaultcreatecallbackstaterequest.md index 200bee7d..0a96dbef 100644 --- a/docs/models/vaultcreatecallbackstaterequest.md +++ b/docs/models/vaultcreatecallbackstaterequest.md @@ -7,4 +7,6 @@ | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `create_callback_state` | [models.CreateCallbackState](../models/createcallbackstate.md) | :heavy_check_mark: | Callback state data | | \ No newline at end of file +| `create_callback_state` | [models.CreateCallbackState](../models/createcallbackstate.md) | :heavy_check_mark: | Callback state data | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultcustomfieldsallrequest.md b/docs/models/vaultcustomfieldsallrequest.md index 4db81825..13f3311b 100644 --- a/docs/models/vaultcustomfieldsallrequest.md +++ b/docs/models/vaultcustomfieldsallrequest.md @@ -8,4 +8,6 @@ | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | \ No newline at end of file diff --git a/docs/models/vaultcustommappingsallrequest.md b/docs/models/vaultcustommappingsallrequest.md index eb96dc16..5b00eaf5 100644 --- a/docs/models/vaultcustommappingsallrequest.md +++ b/docs/models/vaultcustommappingsallrequest.md @@ -3,7 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | -| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/vaultlogsallrequest.md b/docs/models/vaultlogsallrequest.md index 480d6d7f..c84704d7 100644 --- a/docs/models/vaultlogsallrequest.md +++ b/docs/models/vaultlogsallrequest.md @@ -3,8 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `filter_` | [Optional[models.LogsFilter]](../models/logsfilter.md) | :heavy_minus_sign: | Filter results | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `filter_` | [Optional[models.LogsFilter]](../models/logsfilter.md) | :heavy_minus_sign: | Filter results | | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | \ No newline at end of file diff --git a/docs/models/vaultsessionscreaterequest.md b/docs/models/vaultsessionscreaterequest.md new file mode 100644 index 00000000..bfc48322 --- /dev/null +++ b/docs/models/vaultsessionscreaterequest.md @@ -0,0 +1,10 @@ +# VaultSessionsCreateRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `session` | [Optional[models.Session]](../models/session.md) | :heavy_minus_sign: | Additional redirect uri and/or consumer metadata | | \ No newline at end of file diff --git a/docs/models/vaultvalidateconnectionstaterequest.md b/docs/models/vaultvalidateconnectionstaterequest.md index 68140c59..36fdac1c 100644 --- a/docs/models/vaultvalidateconnectionstaterequest.md +++ b/docs/models/vaultvalidateconnectionstaterequest.md @@ -7,4 +7,6 @@ | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `request_body` | [Optional[models.VaultValidateConnectionStateRequestBody]](../models/vaultvalidateconnectionstaterequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/webhookeventlogsallrequest.md b/docs/models/webhookeventlogsallrequest.md index c0b67f0f..3cad5311 100644 --- a/docs/models/webhookeventlogsallrequest.md +++ b/docs/models/webhookeventlogsallrequest.md @@ -3,8 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | -| `filter_` | [Optional[models.WebhookEventLogsFilter]](../models/webhookeventlogsfilter.md) | :heavy_minus_sign: | Filter results | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `filter_` | [Optional[models.WebhookEventLogsFilter]](../models/webhookeventlogsfilter.md) | :heavy_minus_sign: | Filter results | | \ No newline at end of file diff --git a/docs/models/webhookwebhooksaddrequest.md b/docs/models/webhookwebhooksaddrequest.md new file mode 100644 index 00000000..a62e4733 --- /dev/null +++ b/docs/models/webhookwebhooksaddrequest.md @@ -0,0 +1,9 @@ +# WebhookWebhooksAddRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `create_webhook_request` | [models.CreateWebhookRequest](../models/createwebhookrequest.md) | :heavy_check_mark: | N/A | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/webhookwebhooksallrequest.md b/docs/models/webhookwebhooksallrequest.md index 98b3f9a4..924f287b 100644 --- a/docs/models/webhookwebhooksallrequest.md +++ b/docs/models/webhookwebhooksallrequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | \ No newline at end of file diff --git a/docs/models/webhookwebhooksdeleterequest.md b/docs/models/webhookwebhooksdeleterequest.md index 0b2eebaf..23614ebd 100644 --- a/docs/models/webhookwebhooksdeleterequest.md +++ b/docs/models/webhookwebhooksdeleterequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/webhookwebhooksonerequest.md b/docs/models/webhookwebhooksonerequest.md index 121723e8..9b27c391 100644 --- a/docs/models/webhookwebhooksonerequest.md +++ b/docs/models/webhookwebhooksonerequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/models/webhookwebhooksupdaterequest.md b/docs/models/webhookwebhooksupdaterequest.md index 2225e261..715311db 100644 --- a/docs/models/webhookwebhooksupdaterequest.md +++ b/docs/models/webhookwebhooksupdaterequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | -| `update_webhook_request` | [models.UpdateWebhookRequest](../models/updatewebhookrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `update_webhook_request` | [models.UpdateWebhookRequest](../models/updatewebhookrequest.md) | :heavy_check_mark: | N/A | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | \ No newline at end of file diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 4994a019..d411972d 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.activities.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.crm.activities.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.ActivitiesSortBy.CREATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -91,7 +93,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.activities.create(type_=apideck_unify.ActivityType.MEETING, raw=False, service_id="salesforce", activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={ + res = apideck.crm.activities.create(type_=apideck_unify.ActivityType.MEETING, raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={ "id": "123", "type": apideck_unify.Type.PRIMARY, "string": "25 Spring Street, Blackburn, VIC 3130", @@ -186,6 +188,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | [Nullable[models.ActivityType]](../../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z | | `duration_seconds` | *OptionalNullable[int]* | :heavy_minus_sign: | The duration of the activity in seconds | 1800 | @@ -263,7 +267,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.activities.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.crm.activities.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_activity_response is not None @@ -277,6 +281,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -314,7 +320,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.activities.update(id="", type_=apideck_unify.ActivityType.MEETING, service_id="salesforce", raw=False, activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={ + res = apideck.crm.activities.update(id="", type_=apideck_unify.ActivityType.MEETING, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={ "id": "123", "type": apideck_unify.Type.PRIMARY, "string": "25 Spring Street, Blackburn, VIC 3130", @@ -463,6 +469,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `type` | [Nullable[models.ActivityType]](../../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z | @@ -541,7 +549,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.activities.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.activities.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_activity_response is not None @@ -555,6 +563,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/ageddebtorssdk/README.md b/docs/sdks/ageddebtorssdk/README.md index b0a3668b..721459ad 100644 --- a/docs/sdks/ageddebtorssdk/README.md +++ b/docs/sdks/ageddebtorssdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.aged_debtors.get(raw=False, service_id="salesforce", filter_={ + res = apideck.accounting.aged_debtors.get(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", filter_={ "customer_id": "123abc", "supplier_id": "123abc", "report_as_of_date": "2024-01-01", @@ -45,6 +45,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.AgedReportFilter]](../../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"supplier_id": "123abc",
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/sdks/apideckcompanies/README.md b/docs/sdks/apideckcompanies/README.md index f2780165..1f8fb828 100644 --- a/docs/sdks/apideckcompanies/README.md +++ b/docs/sdks/apideckcompanies/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.companies.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.hris.companies.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.companies.create(legal_name="SpaceX", raw=False, service_id="salesforce", display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[ + res = apideck.hris.companies.create(legal_name="SpaceX", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -214,6 +216,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | SpaceX | | `subdomain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | company | @@ -259,7 +263,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.companies.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.hris.companies.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_hris_company_response is not None @@ -273,6 +277,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -310,7 +316,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.companies.update(id="", legal_name="SpaceX", service_id="salesforce", raw=False, display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[ + res = apideck.hris.companies.update(id="", legal_name="SpaceX", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -499,6 +505,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | SpaceX | @@ -545,7 +553,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.companies.delete(id="", service_id="salesforce", raw=False) + res = apideck.hris.companies.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_hris_company_response is not None @@ -559,6 +567,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/apideckcustomers/README.md b/docs/sdks/apideckcustomers/README.md index 182deaf9..6319e799 100644 --- a/docs/sdks/apideckcustomers/README.md +++ b/docs/sdks/apideckcustomers/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.customers.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.ecommerce.customers.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "email": "elon@musk.com", "phone_number": "111-111-1111", }, pass_through={ @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.customers.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ecommerce.customers.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_ecommerce_customer_response is not None @@ -96,6 +98,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/apideckdepartments/README.md b/docs/sdks/apideckdepartments/README.md index 074dbfce..b251302f 100644 --- a/docs/sdks/apideckdepartments/README.md +++ b/docs/sdks/apideckdepartments/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.departments.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.hris.departments.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.departments.create(raw=False, service_id="salesforce", name="R&D", code="2", description="R&D", pass_through=[ + res = apideck.hris.departments.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", name="R&D", code="2", description="R&D", pass_through=[ { "service_id": "", "extend_paths": [ @@ -138,6 +140,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Department name | R&D | | `code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 2 | @@ -176,7 +180,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.departments.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.hris.departments.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_department_response is not None @@ -190,6 +194,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -226,7 +232,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.departments.update(id="", service_id="salesforce", raw=False, name="R&D", code="2", description="R&D", pass_through=[ + res = apideck.hris.departments.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, name="R&D", code="2", description="R&D", pass_through=[ { "service_id": "", "extend_paths": [ @@ -312,6 +318,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Department name | R&D | @@ -351,7 +359,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.departments.delete(id="", service_id="salesforce", raw=False) + res = apideck.hris.departments.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_department_response is not None @@ -365,6 +373,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/apiresourcecoveragesdk/README.md b/docs/sdks/apiresourcecoveragesdk/README.md index 99bb2a6f..61fc3699 100644 --- a/docs/sdks/apiresourcecoveragesdk/README.md +++ b/docs/sdks/apiresourcecoveragesdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.api_resource_coverage.get(id="", resource_id="") + res = apideck.connector.api_resource_coverage.get(id="", resource_id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_api_resource_coverage_response is not None @@ -34,11 +34,12 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/apiresources/README.md b/docs/sdks/apiresources/README.md index 3a336731..317bc465 100644 --- a/docs/sdks/apiresources/README.md +++ b/docs/sdks/apiresources/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.api_resources.get(id="", resource_id="") + res = apideck.connector.api_resources.get(id="", resource_id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_api_resource_response is not None @@ -34,11 +34,12 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/apis/README.md b/docs/sdks/apis/README.md index 66c4eb37..99e05628 100644 --- a/docs/sdks/apis/README.md +++ b/docs/sdks/apis/README.md @@ -25,7 +25,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.apis.list(limit=20, filter_={ + res = apideck.connector.apis.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", limit=20, filter_={ "status": apideck_unify.APIStatus.BETA, }) @@ -40,6 +40,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | | `filter_` | [Optional[models.ApisFilter]](../../models/apisfilter.md) | :heavy_minus_sign: | Apply filters | {
"status": "beta"
} | @@ -74,7 +75,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.apis.get(id="") + res = apideck.connector.apis.get(id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_api_response is not None @@ -85,10 +86,11 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/applicants/README.md b/docs/sdks/applicants/README.md index bd99651e..2b84c893 100644 --- a/docs/sdks/applicants/README.md +++ b/docs/sdks/applicants/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applicants.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.ats.applicants.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "job_id": "1234", }, pass_through={ "search": "San Francisco", @@ -45,6 +45,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -86,7 +88,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applicants.create(raw=False, service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ + res = apideck.ats.applicants.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ { "email": "elon@musk.com", "id": "123", @@ -261,6 +263,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | @@ -326,7 +330,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applicants.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ats.applicants.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_applicant_response is not None @@ -340,6 +344,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -378,7 +384,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applicants.update(id="", service_id="salesforce", raw=False, name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ + res = apideck.ats.applicants.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[ { "email": "elon@musk.com", "id": "123", @@ -582,6 +588,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk | @@ -648,7 +656,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applicants.delete(id="", service_id="salesforce", raw=False) + res = apideck.ats.applicants.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_applicant_response is not None @@ -662,6 +670,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md index 0535a250..76c3de9f 100644 --- a/docs/sdks/applications/README.md +++ b/docs/sdks/applications/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applications.list(raw=False, service_id="salesforce", pass_through={ + res = apideck.ats.applications.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", pass_through={ "search": "San Francisco", }, limit=20) @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applications.create(applicant_id="12345", job_id="12345", raw=False, service_id="salesforce", status=apideck_unify.ApplicationStatus.OPEN, stage={ + res = apideck.ats.applications.create(applicant_id="12345", job_id="12345", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", status=apideck_unify.ApplicationStatus.OPEN, stage={ "id": "12345", "name": "12345", }, pass_through=[ @@ -143,6 +145,8 @@ with Apideck( | `applicant_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | | `job_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `status` | [OptionalNullable[models.ApplicationStatus]](../../models/applicationstatus.md) | :heavy_minus_sign: | N/A | open | | `stage` | [Optional[models.Stage]](../../models/stage.md) | :heavy_minus_sign: | N/A | | @@ -180,7 +184,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applications.get(id="", service_id="salesforce", raw=False) + res = apideck.ats.applications.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.get_application_response is not None @@ -194,6 +198,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -230,7 +236,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applications.update(id="", applicant_id="12345", job_id="12345", service_id="salesforce", raw=False, status=apideck_unify.ApplicationStatus.OPEN, stage={ + res = apideck.ats.applications.update(id="", applicant_id="12345", job_id="12345", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, status=apideck_unify.ApplicationStatus.OPEN, stage={ "id": "12345", "name": "12345", }, pass_through=[ @@ -321,6 +327,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `applicant_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | | `job_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `status` | [OptionalNullable[models.ApplicationStatus]](../../models/applicationstatus.md) | :heavy_minus_sign: | N/A | open | @@ -359,7 +367,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.applications.delete(id="", service_id="salesforce", raw=False) + res = apideck.ats.applications.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_application_response is not None @@ -373,6 +381,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md index 2158bd52..f7acb8c5 100644 --- a/docs/sdks/attachments/README.md +++ b/docs/sdks/attachments/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", raw=False, service_id="salesforce", limit=20, fields="id,updated_at") + res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at") while res is not None: # Handle items @@ -43,6 +43,8 @@ with Apideck( | `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.attachments.get(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.attachments.get(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_attachment_response is not None @@ -97,6 +99,8 @@ with Apideck( | `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -134,7 +138,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.attachments.delete(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce", raw=False) + res = apideck.accounting.attachments.delete(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_attachment_response is not None @@ -150,6 +154,8 @@ with Apideck( | `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -186,7 +192,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.attachments.download(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce", fields="id,updated_at") + res = apideck.accounting.attachments.download(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_attachment_download_response is not None @@ -202,6 +208,8 @@ with Apideck( | `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice | | `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/balancesheetsdk/README.md b/docs/sdks/balancesheetsdk/README.md index c1b10f9d..efb8c716 100644 --- a/docs/sdks/balancesheetsdk/README.md +++ b/docs/sdks/balancesheetsdk/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.balance_sheet.get(service_id="salesforce", pass_through={ + res = apideck.accounting.balance_sheet.get(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", pass_through={ "search": "San Francisco", }, filter_={ "start_date": "2021-01-01", @@ -44,6 +44,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `filter_` | [Optional[models.BalanceSheetFilter]](../../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month"
} | diff --git a/docs/sdks/billpayments/README.md b/docs/sdks/billpayments/README.md index f467a5dd..25fe5ee6 100644 --- a/docs/sdks/billpayments/README.md +++ b/docs/sdks/billpayments/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bill_payments.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.bill_payments.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.PaymentsSortBy.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bill_payments.create(total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), raw=False, service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ + res = apideck.accounting.bill_payments.create(total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -232,6 +234,8 @@ with Apideck( | `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 | | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | @@ -286,7 +290,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bill_payments.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.bill_payments.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_bill_payment_response is not None @@ -300,6 +304,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -338,7 +344,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bill_payments.update(id="", total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), service_id="salesforce", raw=False, currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ + res = apideck.accounting.bill_payments.update(id="", total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -495,6 +501,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 | | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | @@ -550,7 +558,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bill_payments.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.bill_payments.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_bill_payment_response is not None @@ -564,6 +572,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/bills/README.md b/docs/sdks/bills/README.md index fab0ae73..72e0e595 100644 --- a/docs/sdks/bills/README.md +++ b/docs/sdks/bills/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bills.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.bills.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.By.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bills.create(raw=False, service_id="salesforce", bill_number="10001", supplier={ + res = apideck.accounting.bills.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", bill_number="10001", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -264,6 +266,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | | `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | | @@ -331,7 +335,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bills.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.bills.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_bill_response is not None @@ -345,6 +349,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -383,7 +389,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bills.update(id="", service_id="salesforce", raw=False, bill_number="10001", supplier={ + res = apideck.accounting.bills.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, bill_number="10001", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -608,6 +614,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 | @@ -676,7 +684,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.bills.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.bills.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_bill_response is not None @@ -690,6 +698,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md index 4ace9fe5..fba9f181 100644 --- a/docs/sdks/collections/README.md +++ b/docs/sdks/collections/README.md @@ -25,7 +25,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collections.list(raw=False, service_id="salesforce", limit=20, sort={ + res = apideck.issue_tracking.collections.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, sort={ "by": apideck_unify.CollectionsSortBy.NAME, "direction": apideck_unify.SortDirection.DESC, }, pass_through={ @@ -44,6 +44,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -83,7 +85,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collections.get(collection_id="apideck-io", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.issue_tracking.collections.get(collection_id="apideck-io", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_collection_response is not None @@ -97,6 +99,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/collectiontags/README.md b/docs/sdks/collectiontags/README.md index c2b36cbe..fc6687f6 100644 --- a/docs/sdks/collectiontags/README.md +++ b/docs/sdks/collectiontags/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tags.list(collection_id="apideck-io", raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.issue_tracking.collection_tags.list(collection_id="apideck-io", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -40,6 +40,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/sdks/collectionticketcomments/README.md b/docs/sdks/collectionticketcomments/README.md index 24b4b2ec..8454b3eb 100644 --- a/docs/sdks/collectionticketcomments/README.md +++ b/docs/sdks/collectionticketcomments/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_ticket_comments.list(collection_id="apideck-io", ticket_id="", raw=False, service_id="salesforce", limit=20, sort={ + res = apideck.issue_tracking.collection_ticket_comments.list(collection_id="apideck-io", ticket_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, sort={ "by": apideck_unify.CommentsSortBy.CREATED_AT, "direction": apideck_unify.SortDirection.DESC, }, pass_through={ @@ -49,6 +49,8 @@ with Apideck( | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -88,7 +90,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_ticket_comments.create(collection_id="apideck-io", ticket_id="", raw=False, service_id="salesforce", body="What internet provider do you use?", pass_through=[ + res = apideck.issue_tracking.collection_ticket_comments.create(collection_id="apideck-io", ticket_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", body="What internet provider do you use?", pass_through=[ { "service_id": "", "extend_paths": [ @@ -147,6 +149,8 @@ with Apideck( | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `body` | *OptionalNullable[str]* | :heavy_minus_sign: | Body of the comment | What internet provider do you use? | | `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | @@ -183,7 +187,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_ticket_comments.get(id="", collection_id="apideck-io", ticket_id="", raw=False, service_id="salesforce", limit=20, fields="id,updated_at") + res = apideck.issue_tracking.collection_ticket_comments.get(id="", collection_id="apideck-io", ticket_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at") while res is not None: # Handle items @@ -200,6 +204,8 @@ with Apideck( | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -237,7 +243,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_ticket_comments.update(id="", collection_id="apideck-io", ticket_id="", service_id="salesforce", raw=False, body="What internet provider do you use?", pass_through=[ + res = apideck.issue_tracking.collection_ticket_comments.update(id="", collection_id="apideck-io", ticket_id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, body="What internet provider do you use?", pass_through=[ { "service_id": "", "extend_paths": [ @@ -325,6 +331,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `body` | *OptionalNullable[str]* | :heavy_minus_sign: | Body of the comment | What internet provider do you use? | @@ -362,7 +370,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_ticket_comments.delete(id="", collection_id="apideck-io", ticket_id="", service_id="salesforce", raw=False) + res = apideck.issue_tracking.collection_ticket_comments.delete(id="", collection_id="apideck-io", ticket_id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_comment_response is not None @@ -378,6 +386,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/collectiontickets/README.md b/docs/sdks/collectiontickets/README.md index d6449672..051b1131 100644 --- a/docs/sdks/collectiontickets/README.md +++ b/docs/sdks/collectiontickets/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tickets.list(collection_id="apideck-io", raw=False, service_id="salesforce", limit=20, sort={ + res = apideck.issue_tracking.collection_tickets.list(collection_id="apideck-io", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, sort={ "by": apideck_unify.TicketsSortBy.CREATED_AT, "direction": apideck_unify.SortDirection.DESC, }, filter_={ @@ -52,6 +52,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -94,7 +96,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tickets.create(collection_id="apideck-io", raw=False, service_id="salesforce", parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[ + res = apideck.issue_tracking.collection_tickets.create(collection_id="apideck-io", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[ { "id": "12345", }, @@ -150,6 +152,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's parent ID | 12345 | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's type | Technical | @@ -194,7 +198,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tickets.get(ticket_id="", collection_id="apideck-io", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.issue_tracking.collection_tickets.get(ticket_id="", collection_id="apideck-io", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_ticket_response is not None @@ -209,6 +213,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -247,7 +253,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tickets.update(ticket_id="", collection_id="apideck-io", service_id="salesforce", raw=False, parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[ + res = apideck.issue_tracking.collection_tickets.update(ticket_id="", collection_id="apideck-io", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[ { "id": "12345", }, @@ -330,6 +336,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's parent ID | 12345 | @@ -375,7 +383,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_tickets.delete(ticket_id="", collection_id="apideck-io", service_id="salesforce", raw=False) + res = apideck.issue_tracking.collection_tickets.delete(ticket_id="", collection_id="apideck-io", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_ticket_response is not None @@ -390,6 +398,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/collectionusers/README.md b/docs/sdks/collectionusers/README.md index 94f770bc..f930b702 100644 --- a/docs/sdks/collectionusers/README.md +++ b/docs/sdks/collectionusers/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_users.list(collection_id="apideck-io", raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.issue_tracking.collection_users.list(collection_id="apideck-io", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -41,6 +41,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -79,7 +81,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.issue_tracking.collection_users.get(collection_id="apideck-io", id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.issue_tracking.collection_users.get(collection_id="apideck-io", id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_collection_user_response is not None @@ -94,6 +96,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index f8aa9119..3cd8b158 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.companies.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.crm.companies.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "name": "SpaceX", }, sort={ "by": apideck_unify.CompaniesSortBy.CREATED_AT, @@ -49,6 +49,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -91,7 +93,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.companies.create(name="SpaceX", raw=False, service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[ + res = apideck.crm.companies.create(name="SpaceX", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[ { "bank_name": "Monzo", "account_number": "123465", @@ -332,6 +334,8 @@ with Apideck( | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Owner ID | 12345 | | `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The Image URL of the company | https://www.spacex.com/static/images/share.jpg | @@ -397,7 +401,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.companies.get(id="", raw=False, service_id="salesforce", fields="id,updated_at") + res = apideck.crm.companies.get(id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_company_response is not None @@ -412,6 +416,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -449,7 +455,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.companies.update(id="", name="SpaceX", raw=False, service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[ + res = apideck.crm.companies.update(id="", name="SpaceX", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[ { "bank_name": "Monzo", "account_number": "123465", @@ -653,6 +659,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Owner ID | 12345 | | `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The Image URL of the company | https://www.spacex.com/static/images/share.jpg | @@ -718,7 +726,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.companies.delete(id="", raw=False, service_id="salesforce") + res = apideck.crm.companies.delete(id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce") assert res.delete_company_response is not None @@ -733,6 +741,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/companyinfosdk/README.md b/docs/sdks/companyinfosdk/README.md index aeca77ac..ec398480 100644 --- a/docs/sdks/companyinfosdk/README.md +++ b/docs/sdks/companyinfosdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.company_info.get(raw=False, service_id="salesforce", fields="id,updated_at") + res = apideck.accounting.company_info.get(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_company_info_response is not None @@ -37,6 +37,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/connectioncustommappings/README.md b/docs/sdks/connectioncustommappings/README.md index 8ac1a872..15883074 100644 --- a/docs/sdks/connectioncustommappings/README.md +++ b/docs/sdks/connectioncustommappings/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connection_custom_mappings.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") + res = apideck.vault.connection_custom_mappings.list(unified_api="crm", service_id="pipedrive", resource="leads", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", resource_id="1234") assert res.get_custom_mappings_response is not None @@ -39,6 +39,8 @@ with Apideck( | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index 28470792..23c3b752 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -31,7 +31,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.list(api="crm", configured=True) + res = apideck.vault.connections.list(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", api="crm", configured=True) assert res.get_connections_response is not None @@ -44,6 +44,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `api` | *Optional[str]* | :heavy_minus_sign: | Scope results to Unified API | crm | | `configured` | *Optional[bool]* | :heavy_minus_sign: | Scopes results to connections that have been configured or not | true | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -79,7 +81,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.get(service_id="pipedrive", unified_api="crm") + res = apideck.vault.connections.get(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_connection_response is not None @@ -94,6 +96,8 @@ with Apideck( | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -127,7 +131,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.update(service_id="pipedrive", unified_api="crm", enabled=True, settings={ + res = apideck.vault.connections.update(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", enabled=True, settings={ "instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx", }, metadata={ @@ -308,6 +312,8 @@ with Apideck( | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. | true | | `settings` | Dict[str, *Any*] | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com",
"api_key": "12345xxxxxx"
} | | `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} | @@ -346,7 +352,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.delete(service_id="pipedrive", unified_api="crm") + res = apideck.vault.connections.delete(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res is not None @@ -361,6 +367,8 @@ with Apideck( | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -395,7 +403,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.imports(service_id="pipedrive", unified_api="crm", credentials={ + res = apideck.vault.connections.imports(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", credentials={ "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", }, settings={}, metadata={ @@ -419,6 +427,8 @@ with Apideck( | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `credentials` | [Optional[models.Credentials]](../../models/credentials.md) | :heavy_minus_sign: | N/A | {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ"
} | | `settings` | [OptionalNullable[models.ConnectionImportDataSettings]](../../models/connectionimportdatasettings.md) | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com"
} | | `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} | @@ -461,7 +471,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connections.token(service_id="pipedrive", unified_api="crm") + res = apideck.vault.connections.token(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_connection_response is not None @@ -476,6 +486,8 @@ with Apideck( | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `request_body` | [Optional[models.VaultConnectionsTokenRequestBody]](../../models/vaultconnectionstokenrequestbody.md) | :heavy_minus_sign: | N/A | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/connectionsettings/README.md b/docs/sdks/connectionsettings/README.md index 2c0afdfb..f957882d 100644 --- a/docs/sdks/connectionsettings/README.md +++ b/docs/sdks/connectionsettings/README.md @@ -25,7 +25,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connection_settings.list(unified_api="crm", service_id="pipedrive", resource="leads") + res = apideck.vault.connection_settings.list(unified_api="crm", service_id="pipedrive", resource="leads", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_connection_response is not None @@ -41,6 +41,8 @@ with Apideck( | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -74,7 +76,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", enabled=True, settings={ + res = apideck.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", enabled=True, settings={ "instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx", }, metadata={ @@ -256,6 +258,8 @@ with Apideck( | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. | true | | `settings` | Dict[str, *Any*] | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com",
"api_key": "12345xxxxxx"
} | | `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} | diff --git a/docs/sdks/connectordocs/README.md b/docs/sdks/connectordocs/README.md index 9934aadb..1ef3b2ee 100644 --- a/docs/sdks/connectordocs/README.md +++ b/docs/sdks/connectordocs/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.connector_docs.get(id="", doc_id="application_owner+oauth_credentials") + res = apideck.connector.connector_docs.get(id="", doc_id="application_owner+oauth_credentials", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_connector_doc_response is not None @@ -38,6 +38,7 @@ with Apideck( | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `doc_id` | *str* | :heavy_check_mark: | ID of the Doc | application_owner+oauth_credentials | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/connectorresources/README.md b/docs/sdks/connectorresources/README.md index b6fdc658..0bb9d6e1 100644 --- a/docs/sdks/connectorresources/README.md +++ b/docs/sdks/connectorresources/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.connector_resources.get(id="", resource_id="", unified_api=apideck_unify.UnifiedAPIID.CRM) + res = apideck.connector.connector_resources.get(id="", resource_id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", unified_api=apideck_unify.UnifiedAPIID.CRM) assert res.get_connector_resource_response is not None @@ -39,6 +39,7 @@ with Apideck( | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `resource_id` | *str* | :heavy_check_mark: | ID of the resource you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `unified_api` | [Optional[models.UnifiedAPIID]](../../models/unifiedapiid.md) | :heavy_minus_sign: | Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs | crm | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/connectors/README.md b/docs/sdks/connectors/README.md index 1322ca8a..5bd3c0bf 100644 --- a/docs/sdks/connectors/README.md +++ b/docs/sdks/connectors/README.md @@ -25,7 +25,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.connectors.list(limit=20, filter_={ + res = apideck.connector.connectors.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", limit=20, filter_={ "unified_api": apideck_unify.UnifiedAPIID.FILE_STORAGE, }) @@ -40,6 +40,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | | `filter_` | [Optional[models.ConnectorsFilter]](../../models/connectorsfilter.md) | :heavy_minus_sign: | Apply filters | {
"unified_api": "file-storage"
} | @@ -74,7 +75,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.connector.connectors.get(id="") + res = apideck.connector.connectors.get(id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_connector_response is not None @@ -85,10 +86,11 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/consumerrequestcounts/README.md b/docs/sdks/consumerrequestcounts/README.md index 99b2f4c4..84c80fa9 100644 --- a/docs/sdks/consumerrequestcounts/README.md +++ b/docs/sdks/consumerrequestcounts/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z") + res = apideck.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.consumer_request_counts_in_date_range_response is not None @@ -40,6 +40,7 @@ with Apideck( | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | | `start_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened after datetime | 2021-05-01T12:00:00.000Z | | `end_datetime` | *str* | :heavy_check_mark: | Scopes results to requests that happened before datetime | 2021-05-30T12:00:00.000Z | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/consumers/README.md b/docs/sdks/consumers/README.md index 13d91007..6e602f8a 100644 --- a/docs/sdks/consumers/README.md +++ b/docs/sdks/consumers/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumers.create(consumer_id="test_consumer_id", metadata={ + res = apideck.vault.consumers.create(consumer_id="test_consumer_id", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", metadata={ "account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", @@ -46,6 +46,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `consumer_id` | *str* | :heavy_check_mark: | Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. | test_consumer_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `metadata` | [Optional[models.ConsumerMetadata]](../../models/consumermetadata.md) | :heavy_minus_sign: | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -81,7 +82,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumers.list(limit=20) + res = apideck.vault.consumers.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", limit=20) while res is not None: # Handle items @@ -92,11 +93,12 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -130,7 +132,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumers.get(consumer_id="test_user_id") + res = apideck.vault.consumers.get(consumer_id="test_user_id", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_consumer_response is not None @@ -144,6 +146,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -177,7 +180,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumers.update(consumer_id="test_user_id", metadata={ + res = apideck.vault.consumers.update(consumer_id="test_user_id", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", metadata={ "account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", @@ -196,6 +199,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `metadata` | [Optional[models.ConsumerMetadata]](../../models/consumermetadata.md) | :heavy_minus_sign: | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -230,7 +234,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.consumers.delete(consumer_id="test_user_id") + res = apideck.vault.consumers.delete(consumer_id="test_user_id", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.delete_consumer_response is not None @@ -244,6 +248,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index 801d0a76..5621f184 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.contacts.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.crm.contacts.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "first_name": "Elon", "last_name": "Musk", "email": "elon@tesla.com", @@ -53,6 +53,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -94,7 +96,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.contacts.create(name="Elon Musk", raw=False, service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ + res = apideck.crm.contacts.create(name="Elon Musk", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ { "url": "http://example.com", "id": "12345", @@ -302,6 +304,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the contact. | 54321 | | `type` | [OptionalNullable[models.ContactType]](../../models/contacttype.md) | :heavy_minus_sign: | The type of the contact. | personal | @@ -369,7 +373,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.contacts.get(id="", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ + res = apideck.crm.contacts.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ "first_name": "Elon", "last_name": "Musk", "email": "elon@tesla.com", @@ -389,6 +393,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -427,7 +433,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.contacts.update(id="", name="Elon Musk", service_id="salesforce", raw=False, owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ + res = apideck.crm.contacts.update(id="", name="Elon Musk", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[ { "url": "http://example.com", "id": "12345", @@ -591,6 +597,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the contact. | 54321 | @@ -659,7 +667,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.contacts.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.contacts.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_contact_response is not None @@ -673,6 +681,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/createcallback/README.md b/docs/sdks/createcallback/README.md index 06c0e759..0bc2c707 100644 --- a/docs/sdks/createcallback/README.md +++ b/docs/sdks/createcallback/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.create_callback.state(service_id="pipedrive", unified_api="crm", redirect_uri="https://example.com/callback") + res = apideck.vault.create_callback.state(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", redirect_uri="https://example.com/callback") assert res.create_callback_state_response is not None @@ -39,6 +39,8 @@ with Apideck( | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `redirect_uri` | *Optional[str]* | :heavy_minus_sign: | The redirect URI to be used after the connection is created. | https://example.com/callback | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index db82a5a8..eae6e54d 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.credit_notes.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.credit_notes.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.CreditNotesSortBy.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.credit_notes.create(total_amount=49.99, raw=False, service_id="salesforce", number="OIT00546", customer={ + res = apideck.accounting.credit_notes.create(total_amount=49.99, raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", @@ -348,6 +350,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 | | `customer` | [OptionalNullable[models.LinkedCustomerInput]](../../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | | @@ -409,7 +413,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.credit_notes.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.credit_notes.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_credit_note_response is not None @@ -423,6 +427,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -461,7 +467,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.credit_notes.update(id="", total_amount=49.99, service_id="salesforce", raw=False, number="OIT00546", customer={ + res = apideck.accounting.credit_notes.update(id="", total_amount=49.99, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", @@ -796,6 +802,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 | @@ -858,7 +866,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.credit_notes.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.credit_notes.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_credit_note_response is not None @@ -872,6 +880,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index 2224ad42..7093f1e4 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.customers.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.customers.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "company_name": "SpaceX", "display_name": "Elon Musk", "first_name": "Elon", @@ -56,6 +56,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -97,7 +99,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.customers.create(raw=False, service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[ + res = apideck.accounting.customers.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -321,6 +323,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | @@ -383,7 +387,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.customers.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.customers.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_customer_response is not None @@ -397,6 +401,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -434,7 +440,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.customers.update(id="", service_id="salesforce", raw=False, display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[ + res = apideck.accounting.customers.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -637,6 +643,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | @@ -700,7 +708,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.customers.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.customers.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_customer_response is not None @@ -714,6 +722,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/customfields/README.md b/docs/sdks/customfields/README.md index 57e6461d..e13aad3c 100644 --- a/docs/sdks/customfields/README.md +++ b/docs/sdks/customfields/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.custom_fields.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") + res = apideck.vault.custom_fields.list(unified_api="crm", service_id="pipedrive", resource="leads", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", resource_id="1234") assert res.get_custom_fields_response is not None @@ -40,6 +40,8 @@ with Apideck( | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `resource_id` | *Optional[str]* | :heavy_minus_sign: | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | 1234 | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/custommappingssdk/README.md b/docs/sdks/custommappingssdk/README.md index a001af3e..31da35a6 100644 --- a/docs/sdks/custommappingssdk/README.md +++ b/docs/sdks/custommappingssdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.custom_mappings.list(unified_api="crm", service_id="pipedrive") + res = apideck.vault.custom_mappings.list(unified_api="crm", service_id="pipedrive", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_custom_mappings_response is not None @@ -38,6 +38,8 @@ with Apideck( | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md index 58d68b4b..0ecec466 100644 --- a/docs/sdks/departments/README.md +++ b/docs/sdks/departments/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.departments.list(raw=False, service_id="salesforce", limit=20, fields="id,updated_at", filter_={ + res = apideck.accounting.departments.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at", filter_={ "subsidiary": "1", }) @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.departments.create(raw=False, service_id="salesforce", parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[ + res = apideck.accounting.departments.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[ { "name": "SpaceX", }, @@ -138,6 +140,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the department. | Sales | @@ -178,7 +182,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.departments.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.departments.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_accounting_department_response is not None @@ -192,6 +196,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -229,7 +235,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.departments.update(id="", service_id="salesforce", raw=False, parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[ + res = apideck.accounting.departments.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[ { "name": "SpaceX", }, @@ -304,6 +310,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | @@ -345,7 +353,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.departments.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.departments.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_accounting_department_response is not None @@ -359,6 +367,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/drivegroups/README.md b/docs/sdks/drivegroups/README.md index 109034b9..51f2d587 100644 --- a/docs/sdks/drivegroups/README.md +++ b/docs/sdks/drivegroups/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drive_groups.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.file_storage.drive_groups.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "parent_group_id": "1234", }, pass_through={ "search": "San Francisco", @@ -45,6 +45,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -84,7 +86,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drive_groups.create(name="accounting", raw=False, service_id="salesforce", display_name="accounting", description="A description", pass_through=[ + res = apideck.file_storage.drive_groups.create(name="accounting", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", display_name="accounting", description="A description", pass_through=[ { "service_id": "", "extend_paths": [ @@ -142,6 +144,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name of the drive group | accounting | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name of the drive group | accounting | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | @@ -179,7 +183,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drive_groups.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.drive_groups.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_drive_group_response is not None @@ -193,6 +197,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -229,7 +235,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drive_groups.update(id="", name="accounting", service_id="salesforce", raw=False, display_name="accounting", description="A description", pass_through=[ + res = apideck.file_storage.drive_groups.update(id="", name="accounting", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, display_name="accounting", description="A description", pass_through=[ { "service_id": "", "extend_paths": [ @@ -316,6 +322,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `name` | *str* | :heavy_check_mark: | The name of the drive group | accounting | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name of the drive group | accounting | @@ -354,7 +362,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drive_groups.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.drive_groups.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_drive_group_response is not None @@ -368,6 +376,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md index 4e56f9a1..cf19edc2 100644 --- a/docs/sdks/drives/README.md +++ b/docs/sdks/drives/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drives.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.file_storage.drives.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "group_id": "1234", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drives.create(name="Project Resources", raw=False, service_id="salesforce", description="A description", pass_through=[ + res = apideck.file_storage.drives.create(name="Project Resources", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", description="A description", pass_through=[ { "service_id": "", "extend_paths": [ @@ -139,6 +141,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name of the drive | Project Resources | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | | `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | @@ -175,7 +179,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drives.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.drives.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_drive_response is not None @@ -189,6 +193,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -225,7 +231,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drives.update(id="", name="Project Resources", service_id="salesforce", raw=False, description="A description", pass_through=[ + res = apideck.file_storage.drives.update(id="", name="Project Resources", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, description="A description", pass_through=[ { "service_id": "", "extend_paths": [ @@ -312,6 +318,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `name` | *str* | :heavy_check_mark: | The name of the drive | Project Resources | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | @@ -349,7 +357,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.drives.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.drives.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_drive_response is not None @@ -363,6 +371,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/employeepayrolls/README.md b/docs/sdks/employeepayrolls/README.md index 2d1c2dd6..ac29bc20 100644 --- a/docs/sdks/employeepayrolls/README.md +++ b/docs/sdks/employeepayrolls/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employee_payrolls.list(employee_id="", raw=False, service_id="salesforce", filter_={ + res = apideck.hris.employee_payrolls.list(employee_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", filter_={ "start_date": "2022-04-08", "end_date": "2022-04-21", }, pass_through={ @@ -44,6 +44,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.PayrollsFilter]](../../models/payrollsfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2022-04-08",
"end_date": "2022-04-21"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employee_payrolls.get(payroll_id="", employee_id="", raw=False, service_id="salesforce", fields="id,updated_at") + res = apideck.hris.employee_payrolls.get(payroll_id="", employee_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_employee_payroll_response is not None @@ -97,6 +99,8 @@ with Apideck( | `payroll_id` | *str* | :heavy_check_mark: | ID of the payroll you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index 52ecefcb..882d5ac8 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employees.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.hris.employees.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "company_id": "1234", "email": "elon@tesla.com", "first_name": "Elon", @@ -57,6 +57,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -99,7 +101,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employees.create(raw=False, service_id="salesforce", id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={ + res = apideck.hris.employees.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={ "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", @@ -368,6 +370,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon | @@ -463,7 +467,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employees.get(id="", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ + res = apideck.hris.employees.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ "company_id": "1234", }, pass_through={ "search": "San Francisco", @@ -481,6 +485,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -521,7 +527,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employees.update(id_param="", service_id="salesforce", raw=False, id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={ + res = apideck.hris.employees.update(id_param="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={ "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", @@ -848,6 +854,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | @@ -944,7 +952,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employees.delete(id="", service_id="salesforce", raw=False) + res = apideck.hris.employees.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_employee_response is not None @@ -958,6 +966,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/employeeschedulessdk/README.md b/docs/sdks/employeeschedulessdk/README.md index 13bd4fd6..8d0198eb 100644 --- a/docs/sdks/employeeschedulessdk/README.md +++ b/docs/sdks/employeeschedulessdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.employee_schedules.list(employee_id="", raw=False, service_id="salesforce", pass_through={ + res = apideck.hris.employee_schedules.list(employee_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -40,6 +40,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/eventlogs/README.md b/docs/sdks/eventlogs/README.md index 5e8a8513..33c0f3cd 100644 --- a/docs/sdks/eventlogs/README.md +++ b/docs/sdks/eventlogs/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.webhook.event_logs.list(limit=20, filter_={ + res = apideck.webhook.event_logs.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", limit=20, filter_={ "exclude_apis": "vault,proxy", "consumer_id": "test_user_id", "entity_type": "Connection", @@ -39,12 +39,13 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | -| `filter_` | [Optional[models.WebhookEventLogsFilter]](../../models/webhookeventlogsfilter.md) | :heavy_minus_sign: | Filter results | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `filter_` | [Optional[models.WebhookEventLogsFilter]](../../models/webhookeventlogsfilter.md) | :heavy_minus_sign: | Filter results | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index 20f51f1c..7a772b5e 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.expenses.list(raw=False, service_id="salesforce", limit=20) + res = apideck.accounting.expenses.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20) while res is not None: # Handle items @@ -41,6 +41,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -103,7 +105,7 @@ with Apideck( "description": "Travel US.", "billable": True, }, - ], raw=False, service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ + ], raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ "id": "123456", "rate": 10, }, total_amount=275, custom_fields=[ @@ -192,6 +194,8 @@ with Apideck( | `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | | `line_items` | List[[models.ExpenseLineItemInput](../../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. | 12345 | @@ -241,7 +245,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.expenses.get(id="", service_id="salesforce", raw=False) + res = apideck.accounting.expenses.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.get_expense_response is not None @@ -255,6 +259,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -366,7 +372,7 @@ with Apideck( "description": "Travel US.", "billable": True, }, - ], service_id="salesforce", raw=False, number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ + ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={ "id": "123456", "rate": 10, }, total_amount=275, custom_fields=[ @@ -447,6 +453,8 @@ with Apideck( | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 | | `line_items` | List[[models.ExpenseLineItemInput](../../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 | @@ -497,7 +505,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.expenses.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.expenses.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_expense_response is not None @@ -511,6 +519,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md index f5b084a0..33763e36 100644 --- a/docs/sdks/files/README.md +++ b/docs/sdks/files/README.md @@ -30,7 +30,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.file_storage.files.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "drive_id": "1234", "folder_id": "root", "shared": True, @@ -53,6 +53,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -93,7 +95,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.search(query="logo jpg", service_id="salesforce", pass_through_param={ + res = apideck.file_storage.files.search(query="logo jpg", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", pass_through_param={ "search": "San Francisco", }, fields="id,updated_at", limit=20, filter_={ "drive_id": "1234", @@ -127,6 +129,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | *str* | :heavy_check_mark: | The query to search for. May match across multiple fields. | logo jpg | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `pass_through_param` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -168,7 +172,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.files.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_file_response is not None @@ -182,6 +186,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -218,7 +224,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.update(id="", service_id="salesforce", raw=False, name="New Name.pdf", description="Renamed PDF Document", parent_folder_id="1234", pass_through=[ + res = apideck.file_storage.files.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, name="New Name.pdf", description="Renamed PDF Document", parent_folder_id="1234", pass_through=[ { "service_id": "", "extend_paths": [ @@ -304,6 +310,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of the file. | New Name.pdf | @@ -343,7 +351,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.files.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_file_response is not None @@ -357,6 +365,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -392,7 +402,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.download(id="", service_id="salesforce", fields="id,updated_at") + res = apideck.file_storage.files.download(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_file_download_response is not None @@ -406,6 +416,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -441,7 +453,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.files.export(id="", file_format="pdf", service_id="salesforce", fields="id,updated_at") + res = apideck.file_storage.files.export(id="", file_format="pdf", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_file_download_response is not None @@ -456,6 +468,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md index fc7bc4bf..e1a05361 100644 --- a/docs/sdks/folders/README.md +++ b/docs/sdks/folders/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.folders.create(name="Documents", parent_folder_id="1234", raw=False, service_id="salesforce", fields="id,updated_at", description="My Personal Documents", drive_id="1234", pass_through=[ + res = apideck.file_storage.folders.create(name="Documents", parent_folder_id="1234", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at", description="My Personal Documents", drive_id="1234", pass_through=[ { "service_id": "", "extend_paths": [ @@ -86,6 +86,8 @@ with Apideck( | `name` | *str* | :heavy_check_mark: | The name of the folder. | Documents | | `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `description` | *Optional[str]* | :heavy_minus_sign: | Optional description of the folder. | My Personal Documents | @@ -124,7 +126,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.folders.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.folders.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_folder_response is not None @@ -138,6 +140,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -174,7 +178,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.folders.update(id="", service_id="salesforce", raw=False, name="Documents", description="My Personal Documents", parent_folder_id="1234", pass_through=[ + res = apideck.file_storage.folders.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, name="Documents", description="My Personal Documents", parent_folder_id="1234", pass_through=[ { "service_id": "", "extend_paths": [ @@ -260,6 +264,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of the folder. | Documents | @@ -299,7 +305,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.folders.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.folders.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_folder_response is not None @@ -313,6 +319,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -348,7 +356,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.folders.copy(id="", parent_folder_id="1234", service_id="salesforce", raw=False, fields="id,updated_at", name="Documents", pass_through=[ + res = apideck.file_storage.folders.copy(id="", parent_folder_id="1234", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at", name="Documents", pass_through=[ { "service_id": "", "extend_paths": [ @@ -443,6 +451,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/invoiceitems/README.md b/docs/sdks/invoiceitems/README.md index adadaeff..12bf5d6c 100644 --- a/docs/sdks/invoiceitems/README.md +++ b/docs/sdks/invoiceitems/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoice_items.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.invoice_items.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "name": "Widgets Large", "type": apideck_unify.InvoiceItemType.SERVICE, }, pass_through={ @@ -47,6 +47,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -88,7 +90,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoice_items.create(raw=False, service_id="salesforce", name="Model Y", description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", code="120-C", sold=True, purchased=True, tracked=True, taxable=True, inventory_date=dateutil.parser.parse("2020-10-30").date(), type_=apideck_unify.InvoiceItemTypeType.INVENTORY, sales_details={ + res = apideck.accounting.invoice_items.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", name="Model Y", description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", code="120-C", sold=True, purchased=True, tracked=True, taxable=True, inventory_date=dateutil.parser.parse("2020-10-30").date(), type_=apideck_unify.InvoiceItemTypeType.INVENTORY, sales_details={ "unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": True, @@ -174,6 +176,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Item name | Model Y | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A short description of the item | Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection. | @@ -230,7 +234,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoice_items.get(id="", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ + res = apideck.accounting.invoice_items.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at", filter_={ "type": apideck_unify.InvoiceItemFilterInvoiceItemType.SERVICE, }) @@ -246,6 +250,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -285,7 +291,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoice_items.update(id="", service_id="salesforce", raw=False, name="Model Y", description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", code="120-C", sold=True, purchased=True, tracked=True, taxable=True, inventory_date=dateutil.parser.parse("2020-10-30").date(), type_=apideck_unify.InvoiceItemTypeType.INVENTORY, sales_details={ + res = apideck.accounting.invoice_items.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, name="Model Y", description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", code="120-C", sold=True, purchased=True, tracked=True, taxable=True, inventory_date=dateutil.parser.parse("2020-10-30").date(), type_=apideck_unify.InvoiceItemTypeType.INVENTORY, sales_details={ "unit_price": 27500.5, "unit_of_measure": "pc.", "tax_inclusive": True, @@ -391,6 +397,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Item name | Model Y | @@ -447,7 +455,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoice_items.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.invoice_items.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_tax_rate_response is not None @@ -461,6 +469,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index e7f6b3f7..461e61fc 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoices.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.invoices.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), "created_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), "number": "OIT00546", @@ -52,6 +52,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -94,7 +96,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoices.create(raw=False, service_id="salesforce", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ + res = apideck.accounting.invoices.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", @@ -344,6 +346,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `type` | [OptionalNullable[models.InvoiceType]](../../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | | `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Invoice number. | OIT00546 | @@ -417,7 +421,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoices.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.invoices.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_invoice_response is not None @@ -431,6 +435,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -469,7 +475,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoices.update(id="", service_id="salesforce", raw=False, type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ + res = apideck.accounting.invoices.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, type_=apideck_unify.InvoiceType.SERVICE, number="OIT00546", customer={ "id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com", @@ -722,6 +728,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `type` | [OptionalNullable[models.InvoiceType]](../../models/invoicetype.md) | :heavy_minus_sign: | Invoice type | service | @@ -796,7 +804,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.invoices.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.invoices.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_invoice_response is not None @@ -810,6 +818,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index d18209d1..d1c3e376 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.jobs.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.ats.jobs.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -40,6 +40,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -78,7 +80,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ats.jobs.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ats.jobs.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_job_response is not None @@ -92,6 +94,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index e0b9f29f..b7e5128c 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.journal_entries.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.journal_entries.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.JournalEntriesSortBy.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.journal_entries.create(raw=False, service_id="salesforce", title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ + res = apideck.accounting.journal_entries.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ { "type": apideck_unify.JournalEntryLineItemType.DEBIT, "ledger_account": { @@ -261,6 +263,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | @@ -311,7 +315,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.journal_entries.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.journal_entries.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_journal_entry_response is not None @@ -325,6 +329,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -363,7 +369,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.journal_entries.update(id="", service_id="salesforce", raw=False, title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ + res = apideck.accounting.journal_entries.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, title="Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", currency_rate=0.69, currency=apideck_unify.Currency.USD, company_id="12345", line_items=[ { "type": apideck_unify.JournalEntryLineItemType.DEBIT, "ledger_account": { @@ -606,6 +612,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | Journal entry title | Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry | @@ -657,7 +665,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.journal_entries.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.journal_entries.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_journal_entry_response is not None @@ -671,6 +679,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/leads/README.md b/docs/sdks/leads/README.md index 2565e661..1234f678 100644 --- a/docs/sdks/leads/README.md +++ b/docs/sdks/leads/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.leads.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.crm.leads.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "first_name": "Elon", "last_name": "Musk", "email": "elon@tesla.com", @@ -52,6 +52,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -93,7 +95,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.leads.create(name="Elon Musk", company_name="Spacex", raw=False, service_id="salesforce", owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ + res = apideck.crm.leads.create(name="Elon Musk", company_name="Spacex", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ { "url": "http://example.com", "id": "12345", @@ -300,6 +302,8 @@ with Apideck( | `name` | *str* | :heavy_check_mark: | Full name of the lead. | Elon Musk | | `company_name` | *Nullable[str]* | :heavy_check_mark: | The name of the company the lead is associated with. | Spacex | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the lead. | 54321 | | `owner_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the owner of the lead. | John Doe | @@ -357,7 +361,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.leads.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.crm.leads.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_lead_response is not None @@ -371,6 +375,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -408,7 +414,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.leads.update(id="", name="Elon Musk", company_name="Spacex", service_id="salesforce", raw=False, owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ + res = apideck.crm.leads.update(id="", name="Elon Musk", company_name="Spacex", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, owner_id="54321", owner_name="John Doe", company_id="2", lead_id="2", lead_source="Cold Call", first_name="Elon", last_name="Musk", description="A thinker", prefix="Sir", title="CEO", language="EN", status="New", monetary_amount=75000, currency=apideck_unify.Currency.USD, fax="+12129876543", websites=[ { "url": "http://example.com", "id": "12345", @@ -571,6 +577,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `name` | *str* | :heavy_check_mark: | Full name of the lead. | Elon Musk | | `company_name` | *Nullable[str]* | :heavy_check_mark: | The name of the company the lead is associated with. | Spacex | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the lead. | 54321 | @@ -629,7 +637,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.leads.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.leads.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_lead_response is not None @@ -643,6 +651,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/ledgeraccounts/README.md b/docs/sdks/ledgeraccounts/README.md index 050db851..a353e0b4 100644 --- a/docs/sdks/ledgeraccounts/README.md +++ b/docs/sdks/ledgeraccounts/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.ledger_accounts.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.ledger_accounts.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.LedgerAccountsSortBy.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.ledger_accounts.create(raw=False, service_id="salesforce", display_id="1-12345", code="453", classification=apideck_unify.Classification.ASSET, type_=apideck_unify.LedgerAccountType.BANK, sub_type="CHECKING_ACCOUNT", name="Bank account", fully_qualified_name="Asset.Bank.Checking_Account", description="Main checking account", opening_balance=75000, current_balance=20000, currency=apideck_unify.Currency.USD, tax_type="NONE", tax_rate={ + res = apideck.accounting.ledger_accounts.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", display_id="1-12345", code="453", classification=apideck_unify.Classification.ASSET, type_=apideck_unify.LedgerAccountType.BANK, sub_type="CHECKING_ACCOUNT", name="Bank account", fully_qualified_name="Asset.Bank.Checking_Account", description="Main checking account", opening_balance=75000, current_balance=20000, currency=apideck_unify.Currency.USD, tax_type="NONE", tax_rate={ "id": "123456", "rate": 10, }, level=1, active=True, status=apideck_unify.AccountStatus.ACTIVE, header=True, bank_account={ @@ -152,6 +154,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `display_id` | *Optional[str]* | :heavy_minus_sign: | The human readable display ID used when displaying the account | 1-12345 | | `nominal_code` | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The nominal code of the ledger account. | N091 | @@ -212,7 +216,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.ledger_accounts.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.ledger_accounts.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_ledger_account_response is not None @@ -226,6 +230,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -264,7 +270,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.ledger_accounts.update(id="", service_id="salesforce", raw=False, display_id="1-12345", code="453", classification=apideck_unify.Classification.ASSET, type_=apideck_unify.LedgerAccountType.BANK, sub_type="CHECKING_ACCOUNT", name="Bank account", fully_qualified_name="Asset.Bank.Checking_Account", description="Main checking account", opening_balance=75000, current_balance=20000, currency=apideck_unify.Currency.USD, tax_type="NONE", tax_rate={ + res = apideck.accounting.ledger_accounts.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, display_id="1-12345", code="453", classification=apideck_unify.Classification.ASSET, type_=apideck_unify.LedgerAccountType.BANK, sub_type="CHECKING_ACCOUNT", name="Bank account", fully_qualified_name="Asset.Bank.Checking_Account", description="Main checking account", opening_balance=75000, current_balance=20000, currency=apideck_unify.Currency.USD, tax_type="NONE", tax_rate={ "id": "123456", "rate": 10, }, level=1, active=True, status=apideck_unify.AccountStatus.ACTIVE, header=True, bank_account={ @@ -362,6 +368,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `display_id` | *Optional[str]* | :heavy_minus_sign: | The human readable display ID used when displaying the account | 1-12345 | @@ -423,7 +431,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.ledger_accounts.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.ledger_accounts.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_ledger_account_response is not None @@ -437,6 +445,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/locations/README.md b/docs/sdks/locations/README.md index 8798ce04..67326c17 100644 --- a/docs/sdks/locations/README.md +++ b/docs/sdks/locations/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.locations.list(raw=False, service_id="salesforce", limit=20, fields="id,updated_at", filter_={ + res = apideck.accounting.locations.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at", filter_={ "subsidiary": "1", }) @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.locations.create(raw=False, service_id="salesforce", parent_id="12345", company_name="SpaceX", display_name="11 UT - South Jordan", status=apideck_unify.LocationStatus.ACTIVE, addresses=[ + res = apideck.accounting.locations.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="12345", company_name="SpaceX", display_name="11 UT - South Jordan", status=apideck_unify.LocationStatus.ACTIVE, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -183,6 +185,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | @@ -225,7 +229,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.locations.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.locations.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_accounting_location_response is not None @@ -239,6 +243,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -276,7 +282,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.locations.update(id="", service_id="salesforce", raw=False, parent_id="12345", company_name="SpaceX", display_name="11 UT - South Jordan", status=apideck_unify.LocationStatus.ACTIVE, addresses=[ + res = apideck.accounting.locations.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="12345", company_name="SpaceX", display_name="11 UT - South Jordan", status=apideck_unify.LocationStatus.ACTIVE, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -427,6 +433,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | @@ -470,7 +478,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.locations.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.locations.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_accounting_location_response is not None @@ -484,6 +492,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/logs/README.md b/docs/sdks/logs/README.md index f49a0b2c..e3fd6a3b 100644 --- a/docs/sdks/logs/README.md +++ b/docs/sdks/logs/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.logs.list(filter_={ + res = apideck.vault.logs.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", consumer_id="test-consumer", filter_={ "connector_id": "crm+salesforce", "status_code": 201, "exclude_unified_apis": "vault,proxy", @@ -39,12 +39,14 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `filter_` | [Optional[models.LogsFilter]](../../models/logsfilter.md) | :heavy_minus_sign: | Filter results | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `filter_` | [Optional[models.LogsFilter]](../../models/logsfilter.md) | :heavy_minus_sign: | Filter results | | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index d203469c..3c7a94cc 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.sms.messages.list(raw=False, service_id="salesforce", limit=20, fields="id,updated_at") + res = apideck.sms.messages.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at") while res is not None: # Handle items @@ -41,6 +41,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -80,7 +82,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.sms.messages.create(from_="+15017122661", to="+15017122662", body="Hi! How are you doing?", raw=False, service_id="salesforce", subject="Picture", type_=apideck_unify.MessageType.SMS, scheduled_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", reference="CUST001", messaging_service_id="123456", pass_through=[ + res = apideck.sms.messages.create(from_="+15017122661", to="+15017122662", body="Hi! How are you doing?", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", subject="Picture", type_=apideck_unify.MessageType.SMS, scheduled_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", reference="CUST001", messaging_service_id="123456", pass_through=[ { "service_id": "", "extend_paths": [ @@ -140,6 +142,8 @@ with Apideck( | `to` | *str* | :heavy_check_mark: | The phone number that received the message. | +15017122662 | | `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | Picture | | `type` | [Optional[models.MessageType]](../../models/messagetype.md) | :heavy_minus_sign: | Set to sms for SMS messages and mms for MMS messages. | sms | @@ -181,7 +185,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.sms.messages.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.sms.messages.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_message_response is not None @@ -195,6 +199,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -233,7 +239,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.sms.messages.update(id="", from_="+15017122661", to="+15017122662", body="Hi! How are you doing?", service_id="salesforce", raw=False, subject="Picture", type_=apideck_unify.MessageType.SMS, scheduled_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", reference="CUST001", messaging_service_id="123456", pass_through=[ + res = apideck.sms.messages.update(id="", from_="+15017122661", to="+15017122662", body="Hi! How are you doing?", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, subject="Picture", type_=apideck_unify.MessageType.SMS, scheduled_at=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", reference="CUST001", messaging_service_id="123456", pass_through=[ { "service_id": "", "extend_paths": [ @@ -322,6 +328,8 @@ with Apideck( | `from_` | *str* | :heavy_check_mark: | The phone number that initiated the message. | +15017122661 | | `to` | *str* | :heavy_check_mark: | The phone number that received the message. | +15017122662 | | `body` | *str* | :heavy_check_mark: | The message text. | Hi! How are you doing? | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `subject` | *Optional[str]* | :heavy_minus_sign: | N/A | Picture | @@ -364,7 +372,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.sms.messages.delete(id="", service_id="salesforce", raw=False) + res = apideck.sms.messages.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_message_response is not None @@ -378,6 +386,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/notes/README.md b/docs/sdks/notes/README.md index 48fc4233..3f0cec7c 100644 --- a/docs/sdks/notes/README.md +++ b/docs/sdks/notes/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.notes.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.crm.notes.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -81,7 +83,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.notes.create(raw=False, service_id="salesforce", title="Meeting Notes", content="Office hours are 9AM-6PM", owner_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", active=True, pass_through=[ + res = apideck.crm.notes.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", title="Meeting Notes", content="Office hours are 9AM-6PM", owner_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", active=True, pass_through=[ { "service_id": "", "extend_paths": [ @@ -138,6 +140,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the note | Meeting Notes | | `content` | *OptionalNullable[str]* | :heavy_minus_sign: | The content of the note. | Office hours are 9AM-6PM | @@ -181,7 +185,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.notes.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.crm.notes.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_note_response is not None @@ -195,6 +199,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -231,7 +237,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.notes.update(id="", service_id="salesforce", raw=False, title="Meeting Notes", content="Office hours are 9AM-6PM", owner_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", active=True, pass_through=[ + res = apideck.crm.notes.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, title="Meeting Notes", content="Office hours are 9AM-6PM", owner_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", active=True, pass_through=[ { "service_id": "", "extend_paths": [ @@ -317,6 +323,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the note | Meeting Notes | @@ -361,7 +369,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.notes.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.notes.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_note_response is not None @@ -375,6 +383,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/opportunities/README.md b/docs/sdks/opportunities/README.md index 8bcec7ca..d44e5b84 100644 --- a/docs/sdks/opportunities/README.md +++ b/docs/sdks/opportunities/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.opportunities.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.crm.opportunities.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "status": "Completed", "monetary_amount": 75000, }, sort={ @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.opportunities.create(title="New Rocket", primary_contact_id="12345", raw=False, service_id="salesforce", description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", type_="Existing Customer - Upgrade", monetary_amount=75000, currency=apideck_unify.Currency.USD, win_probability=40, close_date=dateutil.parser.parse("2020-10-30").date(), loss_reason_id="12345", loss_reason="No budget", won_reason_id="12345", won_reason="Best pitch", pipeline_id="12345", pipeline_stage_id="12345", source_id="12345", lead_id="12345", lead_source="Website", contact_id="12345", contact_ids=[ + res = apideck.crm.opportunities.create(title="New Rocket", primary_contact_id="12345", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", type_="Existing Customer - Upgrade", monetary_amount=75000, currency=apideck_unify.Currency.USD, win_probability=40, close_date=dateutil.parser.parse("2020-10-30").date(), loss_reason_id="12345", loss_reason="No budget", won_reason_id="12345", won_reason="Best pitch", pipeline_id="12345", pipeline_stage_id="12345", source_id="12345", lead_id="12345", lead_source="Website", contact_id="12345", contact_ids=[ "12345", ], company_id="12345", company_name="Copper", owner_id="12345", priority="None", status="Open", status_id="12345", tags=[ "New", @@ -139,6 +141,8 @@ with Apideck( | `title` | *str* | :heavy_check_mark: | The title or name of the opportunity. | New Rocket | | `primary_contact_id` | *Nullable[str]* | :heavy_check_mark: | The unique identifier of the primary contact associated with the opportunity. | 12345 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the opportunity. | Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | The type of the opportunity | Existing Customer - Upgrade | @@ -200,7 +204,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.opportunities.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.crm.opportunities.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_opportunity_response is not None @@ -214,6 +218,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -252,7 +258,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.opportunities.update(id="", title="New Rocket", primary_contact_id="12345", service_id="salesforce", raw=False, description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", type_="Existing Customer - Upgrade", monetary_amount=75000, currency=apideck_unify.Currency.USD, win_probability=40, close_date=dateutil.parser.parse("2020-10-30").date(), loss_reason_id="12345", loss_reason="No budget", won_reason_id="12345", won_reason="Best pitch", pipeline_id="12345", pipeline_stage_id="12345", source_id="12345", lead_id="12345", lead_source="Website", contact_id="12345", contact_ids=[ + res = apideck.crm.opportunities.update(id="", title="New Rocket", primary_contact_id="12345", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", type_="Existing Customer - Upgrade", monetary_amount=75000, currency=apideck_unify.Currency.USD, win_probability=40, close_date=dateutil.parser.parse("2020-10-30").date(), loss_reason_id="12345", loss_reason="No budget", won_reason_id="12345", won_reason="Best pitch", pipeline_id="12345", pipeline_stage_id="12345", source_id="12345", lead_id="12345", lead_source="Website", contact_id="12345", contact_ids=[ "12345", ], company_id="12345", company_name="Copper", owner_id="12345", priority="None", status="Open", status_id="12345", tags=[ "New", @@ -337,6 +343,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `title` | *str* | :heavy_check_mark: | The title or name of the opportunity. | New Rocket | | `primary_contact_id` | *Nullable[str]* | :heavy_check_mark: | The unique identifier of the primary contact associated with the opportunity. | 12345 | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the opportunity. | Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines. | @@ -399,7 +407,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.opportunities.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.opportunities.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_opportunity_response is not None @@ -413,6 +421,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index 17626605..7c0c47f8 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -25,7 +25,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.orders.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.ecommerce.orders.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "email": "elon@musk.com", "customer_id": "123", "updated_since": "2020-09-30T07:43:32.000Z", @@ -49,6 +49,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -89,7 +91,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.orders.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ecommerce.orders.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_ecommerce_order_response is not None @@ -103,6 +105,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index 5a586f29..db271bb1 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.payments.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.payments.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), }, sort={ "by": apideck_unify.PaymentsSortBy.UPDATED_AT, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.payments.create(total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), raw=False, service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ + res = apideck.accounting.payments.create(total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -205,6 +207,8 @@ with Apideck( | `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 | | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | | `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 | @@ -262,7 +266,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.payments.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.payments.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_payment_response is not None @@ -276,6 +280,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -314,7 +320,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.payments.update(id="", total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), service_id="salesforce", raw=False, currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ + res = apideck.accounting.payments.update(id="", total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={ "id": "123456", "nominal_code": "N091", "code": "453", @@ -443,6 +449,8 @@ with Apideck( | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 | | `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | @@ -501,7 +509,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.payments.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.payments.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_payment_response is not None @@ -515,6 +523,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/payrolls/README.md b/docs/sdks/payrolls/README.md index b7f13803..db2ce36b 100644 --- a/docs/sdks/payrolls/README.md +++ b/docs/sdks/payrolls/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.payrolls.list(raw=False, service_id="salesforce", filter_={ + res = apideck.hris.payrolls.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", filter_={ "start_date": "2022-04-08", "end_date": "2022-04-21", }, pass_through={ @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.PayrollsFilter]](../../models/payrollsfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2022-04-08",
"end_date": "2022-04-21"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | @@ -80,7 +82,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.payrolls.get(payroll_id="", raw=False, service_id="salesforce", fields="id,updated_at") + res = apideck.hris.payrolls.get(payroll_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", fields="id,updated_at") assert res.get_payroll_response is not None @@ -95,6 +97,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `payroll_id` | *str* | :heavy_check_mark: | ID of the payroll you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/pipelines/README.md b/docs/sdks/pipelines/README.md index 94145655..ec022b62 100644 --- a/docs/sdks/pipelines/README.md +++ b/docs/sdks/pipelines/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.pipelines.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.crm.pipelines.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -39,6 +39,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | diff --git a/docs/sdks/products/README.md b/docs/sdks/products/README.md index a4a871d0..f8a4d0eb 100644 --- a/docs/sdks/products/README.md +++ b/docs/sdks/products/README.md @@ -24,7 +24,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.products.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.ecommerce.products.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -40,6 +40,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -78,7 +80,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.products.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ecommerce.products.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_product_response is not None @@ -92,6 +94,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/profitandlosssdk/README.md b/docs/sdks/profitandlosssdk/README.md index c14eae40..e7978323 100644 --- a/docs/sdks/profitandlosssdk/README.md +++ b/docs/sdks/profitandlosssdk/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.profit_and_loss.get(raw=False, service_id="salesforce", filter_={ + res = apideck.accounting.profit_and_loss.get(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", filter_={ "customer_id": "123abc", "start_date": "2021-01-01", "end_date": "2021-12-31", @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `filter_` | [Optional[models.ProfitAndLossFilter]](../../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31"
} | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index d8929b5c..509adfa4 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.purchase_orders.list(raw=False, service_id="salesforce", pass_through={ + res = apideck.accounting.purchase_orders.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", pass_through={ "search": "San Francisco", }, limit=20, filter_={ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -51,6 +51,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | @@ -92,7 +94,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.purchase_orders.create(raw=False, service_id="salesforce", po_number="90000117", reference="123456", supplier={ + res = apideck.accounting.purchase_orders.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", po_number="90000117", reference="123456", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -392,6 +394,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `po_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. | 90000117 | | `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional purchase order reference. | 123456 | @@ -455,7 +459,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.purchase_orders.get(id="", service_id="salesforce", raw=False) + res = apideck.accounting.purchase_orders.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.get_purchase_order_response is not None @@ -469,6 +473,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -506,7 +512,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.purchase_orders.update(id="", service_id="salesforce", raw=False, po_number="90000117", reference="123456", supplier={ + res = apideck.accounting.purchase_orders.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, po_number="90000117", reference="123456", supplier={ "id": "12345", "display_name": "Windsurf Shop", "address": { @@ -829,6 +835,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `po_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. | 90000117 | @@ -893,7 +901,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.purchase_orders.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.purchase_orders.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_purchase_order_response is not None @@ -907,6 +915,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index 26146aa5..8a3b64d2 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.sessions.create(request={ + res = apideck.vault.sessions.create(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", session={ "consumer_metadata": { "account_name": "SpaceX", "user_name": "Elon Musk", @@ -84,10 +84,12 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `request` | [models.Session](../../models/session.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `session` | [Optional[models.Session]](../../models/session.md) | :heavy_minus_sign: | Additional redirect uri and/or consumer metadata | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/sharedlinks/README.md b/docs/sdks/sharedlinks/README.md index 80cf0034..0d088628 100644 --- a/docs/sdks/sharedlinks/README.md +++ b/docs/sdks/sharedlinks/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.shared_links.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.file_storage.shared_links.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.shared_links.create(target_id="", raw=False, service_id="salesforce", download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", scope=apideck_unify.Scope.COMPANY, pass_through=[ + res = apideck.file_storage.shared_links.create(target_id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", scope=apideck_unify.Scope.COMPANY, pass_through=[ { "service_id": "", "extend_paths": [ @@ -140,6 +142,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `target_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the file or folder to link. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `download_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL that can be used to download the file. | https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg | | `scope` | [OptionalNullable[models.Scope]](../../models/scope.md) | :heavy_minus_sign: | The scope of the shared link. | company | @@ -178,7 +182,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.shared_links.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.shared_links.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_shared_link_response is not None @@ -192,6 +196,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -229,7 +235,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.shared_links.update(id="", target_id="", service_id="salesforce", raw=False, download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", scope=apideck_unify.Scope.COMPANY, pass_through=[ + res = apideck.file_storage.shared_links.update(id="", target_id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", scope=apideck_unify.Scope.COMPANY, pass_through=[ { "service_id": "", "extend_paths": [ @@ -316,6 +322,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `target_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the file or folder to link. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `download_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL that can be used to download the file. | https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg | @@ -355,7 +363,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.shared_links.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.shared_links.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_shared_link_response is not None @@ -369,6 +377,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/stores/README.md b/docs/sdks/stores/README.md index b592ddb5..6d1fa23f 100644 --- a/docs/sdks/stores/README.md +++ b/docs/sdks/stores/README.md @@ -23,7 +23,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.ecommerce.stores.get(service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.ecommerce.stores.get(consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_store_response is not None @@ -36,6 +36,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | diff --git a/docs/sdks/subsidiaries/README.md b/docs/sdks/subsidiaries/README.md index 244c0d03..84a71b94 100644 --- a/docs/sdks/subsidiaries/README.md +++ b/docs/sdks/subsidiaries/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.subsidiaries.list(raw=False, service_id="salesforce", limit=20, fields="id,updated_at") + res = apideck.accounting.subsidiaries.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, fields="id,updated_at") while res is not None: # Handle items @@ -41,6 +41,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -79,7 +81,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.subsidiaries.create(raw=False, service_id="salesforce", parent_id="12345", name="SpaceX", status=apideck_unify.SubsidiaryStatus.ACTIVE, row_version="1-12345", pass_through=[ + res = apideck.accounting.subsidiaries.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="12345", name="SpaceX", status=apideck_unify.SubsidiaryStatus.ACTIVE, row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -136,6 +138,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX | @@ -175,7 +179,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.subsidiaries.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.subsidiaries.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_subsidiary_response is not None @@ -189,6 +193,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -226,7 +232,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.subsidiaries.update(id="", service_id="salesforce", raw=False, parent_id="12345", name="SpaceX", status=apideck_unify.SubsidiaryStatus.ACTIVE, row_version="1-12345", pass_through=[ + res = apideck.accounting.subsidiaries.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="12345", name="SpaceX", status=apideck_unify.SubsidiaryStatus.ACTIVE, row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -312,6 +318,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | @@ -352,7 +360,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.subsidiaries.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.subsidiaries.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_subsidiary_response is not None @@ -366,6 +374,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/suppliers/README.md b/docs/sdks/suppliers/README.md index 0b874cb3..18a4dfcd 100644 --- a/docs/sdks/suppliers/README.md +++ b/docs/sdks/suppliers/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.suppliers.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.suppliers.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "company_name": "SpaceX", "display_name": "Elon Musk", "first_name": "Elon", @@ -55,6 +55,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -96,7 +98,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.suppliers.create(raw=False, service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, addresses=[ + res = apideck.accounting.suppliers.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -317,6 +319,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | | `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop | @@ -378,7 +382,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.suppliers.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.suppliers.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_supplier_response is not None @@ -392,6 +396,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -429,7 +435,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.suppliers.update(id="", service_id="salesforce", raw=False, display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, addresses=[ + res = apideck.accounting.suppliers.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -629,6 +635,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 | @@ -691,7 +699,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.suppliers.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.suppliers.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_supplier_response is not None @@ -705,6 +713,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/taxrates/README.md b/docs/sdks/taxrates/README.md index c05a7456..e66e6ed4 100644 --- a/docs/sdks/taxrates/README.md +++ b/docs/sdks/taxrates/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.accounting.tax_rates.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "assets": True, "equity": True, "expenses": True, @@ -50,6 +50,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -90,7 +92,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.create(raw=False, service_id="salesforce", id="1234", name="GST on Purchases", code="ABN", description="Reduced rate GST Purchases", effective_tax_rate=10, total_tax_rate=10, tax_payable_account_id="123456", tax_remitted_account_id="123456", components=[ + res = apideck.accounting.tax_rates.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", id="1234", name="GST on Purchases", code="ABN", description="Reduced rate GST Purchases", effective_tax_rate=10, total_tax_rate=10, tax_payable_account_id="123456", tax_remitted_account_id="123456", components=[ { "id": "10", "name": "GST", @@ -163,6 +165,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID assigned to identify this tax rate. | 1234 | | `name` | *Optional[str]* | :heavy_minus_sign: | Name assigned to identify this tax rate. | GST on Purchases | @@ -215,7 +219,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.tax_rates.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_tax_rate_response is not None @@ -229,6 +233,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -266,7 +272,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.update(id_param="", service_id="salesforce", raw=False, id="1234", name="GST on Purchases", code="ABN", description="Reduced rate GST Purchases", effective_tax_rate=10, total_tax_rate=10, tax_payable_account_id="123456", tax_remitted_account_id="123456", components=[ + res = apideck.accounting.tax_rates.update(id_param="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, id="1234", name="GST on Purchases", code="ABN", description="Reduced rate GST Purchases", effective_tax_rate=10, total_tax_rate=10, tax_payable_account_id="123456", tax_remitted_account_id="123456", components=[ { "id": "10", "name": "GST", @@ -363,6 +369,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID assigned to identify this tax rate. | 1234 | @@ -415,7 +423,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tax_rates.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.tax_rates.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_tax_rate_response is not None @@ -429,6 +437,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/timeoffrequests/README.md b/docs/sdks/timeoffrequests/README.md index 5c0a84b8..028c68da 100644 --- a/docs/sdks/timeoffrequests/README.md +++ b/docs/sdks/timeoffrequests/README.md @@ -28,7 +28,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.time_off_requests.list(raw=False, service_id="salesforce", limit=20, filter_={ + res = apideck.hris.time_off_requests.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, filter_={ "start_date": "2022-04-08", "end_date": "2022-04-21", "updated_since": "2020-09-30T07:43:32.000Z", @@ -51,6 +51,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -91,7 +93,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.time_off_requests.create(raw=False, service_id="salesforce", employee_id="12345", policy_id="12345", status=apideck_unify.TimeOffRequestStatusStatus.APPROVED, description="Enjoying some sun.", start_date="2022-04-01", end_date="2022-04-01", request_date="2022-03-21", request_type=apideck_unify.RequestType.VACATION, approval_date="2022-03-21", units=apideck_unify.Units.HOURS, amount=3.5, day_part="morning", notes={ + res = apideck.hris.time_off_requests.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", employee_id="12345", policy_id="12345", status=apideck_unify.TimeOffRequestStatusStatus.APPROVED, description="Enjoying some sun.", start_date="2022-04-01", end_date="2022-04-01", request_date="2022-03-21", request_type=apideck_unify.RequestType.VACATION, approval_date="2022-03-21", units=apideck_unify.Units.HOURS, amount=3.5, day_part="morning", notes={ "employee": "Relaxing on the beach for a few hours.", "manager": "Enjoy!", }, pass_through=[ @@ -151,6 +153,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `employee_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the employee | 12345 | | `policy_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the policy | 12345 | @@ -200,7 +204,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.time_off_requests.get(id="", employee_id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.hris.time_off_requests.get(id="", employee_id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_time_off_request_response is not None @@ -215,6 +219,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -252,7 +258,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.time_off_requests.update(id="", employee_id_param="", service_id="salesforce", raw=False, employee_id="12345", policy_id="12345", status=apideck_unify.TimeOffRequestStatusStatus.APPROVED, description="Enjoying some sun.", start_date="2022-04-01", end_date="2022-04-01", request_date="2022-03-21", request_type=apideck_unify.RequestType.VACATION, approval_date="2022-03-21", units=apideck_unify.Units.HOURS, amount=3.5, day_part="morning", notes={ + res = apideck.hris.time_off_requests.update(id="", employee_id_param="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, employee_id="12345", policy_id="12345", status=apideck_unify.TimeOffRequestStatusStatus.APPROVED, description="Enjoying some sun.", start_date="2022-04-01", end_date="2022-04-01", request_date="2022-03-21", request_type=apideck_unify.RequestType.VACATION, approval_date="2022-03-21", units=apideck_unify.Units.HOURS, amount=3.5, day_part="morning", notes={ "employee": "Relaxing on the beach for a few hours.", "manager": "Enjoy!", }, pass_through=[ @@ -342,6 +348,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id_param` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `employee_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the employee | 12345 | @@ -392,7 +400,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.hris.time_off_requests.delete(id="", employee_id="", service_id="salesforce", raw=False) + res = apideck.hris.time_off_requests.delete(id="", employee_id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_time_off_request_response is not None @@ -407,6 +415,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/trackingcategories/README.md b/docs/sdks/trackingcategories/README.md index 2b5741a5..5f71df98 100644 --- a/docs/sdks/trackingcategories/README.md +++ b/docs/sdks/trackingcategories/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tracking_categories.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.accounting.tracking_categories.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -82,7 +84,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tracking_categories.create(raw=False, service_id="salesforce", parent_id="12345", name="Department", code="100", status=apideck_unify.TrackingCategoryStatus.ACTIVE, row_version="1-12345", pass_through=[ + res = apideck.accounting.tracking_categories.create(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="12345", name="Department", code="100", status=apideck_unify.TrackingCategoryStatus.ACTIVE, row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -139,6 +141,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *Optional[str]* | :heavy_minus_sign: | The name of the tracking category. | Department | @@ -180,7 +184,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tracking_categories.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.accounting.tracking_categories.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_tracking_category_response is not None @@ -194,6 +198,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -231,7 +237,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tracking_categories.update(id="", service_id="salesforce", raw=False, parent_id="12345", name="Department", code="100", status=apideck_unify.TrackingCategoryStatus.ACTIVE, row_version="1-12345", pass_through=[ + res = apideck.accounting.tracking_categories.update(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="12345", name="Department", code="100", status=apideck_unify.TrackingCategoryStatus.ACTIVE, row_version="1-12345", pass_through=[ { "service_id": "", "extend_paths": [ @@ -317,6 +323,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | @@ -359,7 +367,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.accounting.tracking_categories.delete(id="", service_id="salesforce", raw=False) + res = apideck.accounting.tracking_categories.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_tracking_category_response is not None @@ -373,6 +381,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/uploadsessions/README.md b/docs/sdks/uploadsessions/README.md index c75a7651..31039b30 100644 --- a/docs/sdks/uploadsessions/README.md +++ b/docs/sdks/uploadsessions/README.md @@ -26,7 +26,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.upload_sessions.create(name="Documents", parent_folder_id="1234", size=1810673, raw=False, service_id="salesforce", drive_id="1234", pass_through=[ + res = apideck.file_storage.upload_sessions.create(name="Documents", parent_folder_id="1234", size=1810673, raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", drive_id="1234", pass_through=[ { "service_id": "", "extend_paths": [ @@ -86,6 +86,8 @@ with Apideck( | `parent_folder_id` | *str* | :heavy_check_mark: | The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. | 1234 | | `size` | *Nullable[int]* | :heavy_check_mark: | The size of the file in bytes | 1810673 | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `drive_id` | *Optional[str]* | :heavy_minus_sign: | ID of the drive to upload to. | 1234 | | `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | | @@ -123,7 +125,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.upload_sessions.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.file_storage.upload_sessions.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_upload_session_response is not None @@ -137,6 +139,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -174,7 +178,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.upload_sessions.delete(id="", service_id="salesforce", raw=False) + res = apideck.file_storage.upload_sessions.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_upload_session_response is not None @@ -188,6 +192,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -223,7 +229,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.file_storage.upload_sessions.finish(id="", raw=False, service_id="salesforce", digest="sha=fpRyg5eVQletdZqEKaFlqwBXJzM=") + res = apideck.file_storage.upload_sessions.finish(id="", raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", digest="sha=fpRyg5eVQletdZqEKaFlqwBXJzM=") assert res.get_file_response is not None @@ -238,6 +244,8 @@ with Apideck( | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `digest` | *Optional[str]* | :heavy_minus_sign: | The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) | sha=fpRyg5eVQletdZqEKaFlqwBXJzM= | | `request_body` | [Optional[models.FileStorageUploadSessionsFinishRequestBody]](../../models/filestorageuploadsessionsfinishrequestbody.md) | :heavy_minus_sign: | N/A | | diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index b14a99d6..b41f95b1 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.users.list(raw=False, service_id="salesforce", limit=20, pass_through={ + res = apideck.crm.users.list(raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", limit=20, pass_through={ "search": "San Francisco", }, fields="id,updated_at") @@ -43,6 +43,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | | `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | @@ -88,7 +90,7 @@ with Apideck( "id": "123", "type": apideck_unify.EmailType.PRIMARY, }, - ], raw=False, service_id="salesforce", parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ + ], raw=False, consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -187,6 +189,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `emails` | List[[models.Email](../../models/email.md)] | :heavy_check_mark: | N/A | | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The parent user id | 54321 | | `username` | *OptionalNullable[str]* | :heavy_minus_sign: | The username of the user | masterofcoin | @@ -238,7 +242,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.users.get(id="", service_id="salesforce", raw=False, fields="id,updated_at") + res = apideck.crm.users.get(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, fields="id,updated_at") assert res.get_user_response is not None @@ -252,6 +256,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | @@ -295,7 +301,7 @@ with Apideck( "id": "123", "type": apideck_unify.EmailType.PRIMARY, }, - ], service_id="salesforce", raw=False, parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ + ], consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False, parent_id="54321", username="masterofcoin", first_name="Elon", last_name="Musk", title="CEO", division="Europe", company_name="SpaceX", employee_number="123456-AB", description="A description", image="https://logo.clearbit.com/spacex.com?s=128", language="EN", status="active", password="supersecretpassword", addresses=[ { "id": "123", "type": apideck_unify.Type.PRIMARY, @@ -478,6 +484,8 @@ with Apideck( | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | | `emails` | List[[models.Email](../../models/email.md)] | :heavy_check_mark: | N/A | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The parent user id | 54321 | @@ -530,7 +538,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.crm.users.delete(id="", service_id="salesforce", raw=False) + res = apideck.crm.users.delete(id="", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", service_id="salesforce", raw=False) assert res.delete_user_response is not None @@ -544,6 +552,8 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/validateconnection/README.md b/docs/sdks/validateconnection/README.md index 188679e6..9a991417 100644 --- a/docs/sdks/validateconnection/README.md +++ b/docs/sdks/validateconnection/README.md @@ -29,7 +29,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.vault.validate_connection.state(service_id="pipedrive", unified_api="crm") + res = apideck.vault.validate_connection.state(service_id="pipedrive", unified_api="crm", consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.validate_connection_state_response is not None @@ -44,6 +44,8 @@ with Apideck( | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive | | `unified_api` | *str* | :heavy_check_mark: | Unified API | crm | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `request_body` | [Optional[models.VaultValidateConnectionStateRequestBody]](../../models/vaultvalidateconnectionstaterequestbody.md) | :heavy_minus_sign: | N/A | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/webhooks/README.md b/docs/sdks/webhooks/README.md index e934a3f9..68da78ed 100644 --- a/docs/sdks/webhooks/README.md +++ b/docs/sdks/webhooks/README.md @@ -27,7 +27,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.webhook.webhooks.list(limit=20) + res = apideck.webhook.webhooks.list(app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", limit=20) while res is not None: # Handle items @@ -38,11 +38,12 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -79,7 +80,7 @@ with Apideck( res = apideck.webhook.webhooks.create(unified_api=apideck_unify.UnifiedAPIID.CRM, status=apideck_unify.Status.ENABLED, delivery_url="https://example.com/my/webhook/endpoint", events=[ apideck_unify.WebhookEventType.VAULT_CONNECTION_CREATED, apideck_unify.WebhookEventType.VAULT_CONNECTION_UPDATED, - ], description="A description") + ], app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", description="A description") assert res.create_webhook_response is not None @@ -96,6 +97,7 @@ with Apideck( | `status` | [models.Status](../../models/status.md) | :heavy_check_mark: | The status of the webhook. | enabled | | `delivery_url` | *str* | :heavy_check_mark: | The delivery url of the webhook endpoint. | https://example.com/my/webhook/endpoint | | `events` | List[[models.WebhookEventType](../../models/webhookeventtype.md)] | :heavy_check_mark: | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | [
"vault.connection.created",
"vault.connection.updated"
] | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -130,7 +132,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.webhook.webhooks.get(id="") + res = apideck.webhook.webhooks.get(id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.get_webhook_response is not None @@ -141,10 +143,11 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -178,7 +181,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.webhook.webhooks.update(id="", description="A description", status=apideck_unify.Status.ENABLED, delivery_url="https://example.com/my/webhook/endpoint", events=[ + res = apideck.webhook.webhooks.update(id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", description="A description", status=apideck_unify.Status.ENABLED, delivery_url="https://example.com/my/webhook/endpoint", events=[ apideck_unify.WebhookEventType.VAULT_CONNECTION_CREATED, apideck_unify.WebhookEventType.VAULT_CONNECTION_UPDATED, ]) @@ -195,6 +198,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description | | `status` | [Optional[models.Status]](../../models/status.md) | :heavy_minus_sign: | The status of the webhook. | enabled | | `delivery_url` | *Optional[str]* | :heavy_minus_sign: | The delivery url of the webhook endpoint. | https://example.com/my/webhook/endpoint | @@ -232,7 +236,7 @@ with Apideck( app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", ) as apideck: - res = apideck.webhook.webhooks.delete(id="") + res = apideck.webhook.webhooks.delete(id="", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX") assert res.delete_webhook_response is not None @@ -243,10 +247,11 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/pyproject.toml b/pyproject.toml index 3fb748f6..d3e68e2c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "apideck-unify" -version = "0.4.0" +version = "0.5.0" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/src/apideck_unify/_version.py b/src/apideck_unify/_version.py index 06e56d9c..b1b082e5 100644 --- a/src/apideck_unify/_version.py +++ b/src/apideck_unify/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "apideck-unify" -__version__: str = "0.4.0" +__version__: str = "0.5.0" __openapi_doc_version__: str = "10.10.0" -__gen_version__: str = "2.493.32" -__user_agent__: str = "speakeasy-sdk/python 0.4.0 2.493.32 10.10.0 apideck-unify" +__gen_version__: str = "2.493.34" +__user_agent__: str = "speakeasy-sdk/python 0.5.0 2.493.34 10.10.0 apideck-unify" try: if __package__ is not None: diff --git a/src/apideck_unify/activities.py b/src/apideck_unify/activities.py index 22315938..fb7cfaf7 100644 --- a/src/apideck_unify/activities.py +++ b/src/apideck_unify/activities.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -35,6 +37,8 @@ def list( List activities :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -57,6 +61,8 @@ def list( request = models.CrmActivitiesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -123,6 +129,8 @@ def next_func() -> Optional[models.CrmActivitiesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -191,6 +199,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -212,6 +222,8 @@ async def list_async( List activities :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -234,6 +246,8 @@ async def list_async( request = models.CrmActivitiesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -300,6 +314,8 @@ def next_func() -> Optional[models.CrmActivitiesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -369,6 +385,8 @@ def create( *, type_: Nullable[models.ActivityType], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, activity_datetime: OptionalNullable[str] = UNSET, duration_seconds: OptionalNullable[int] = UNSET, @@ -435,6 +453,8 @@ def create( :param type: The type of the activity :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param activity_datetime: The date and time of the activity :param duration_seconds: The duration of the activity in seconds @@ -494,6 +514,8 @@ def create( request = models.CrmActivitiesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, activity=models.ActivityInput( activity_datetime=activity_datetime, @@ -656,6 +678,8 @@ async def create_async( *, type_: Nullable[models.ActivityType], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, activity_datetime: OptionalNullable[str] = UNSET, duration_seconds: OptionalNullable[int] = UNSET, @@ -722,6 +746,8 @@ async def create_async( :param type: The type of the activity :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param activity_datetime: The date and time of the activity :param duration_seconds: The duration of the activity in seconds @@ -781,6 +807,8 @@ async def create_async( request = models.CrmActivitiesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, activity=models.ActivityInput( activity_datetime=activity_datetime, @@ -942,6 +970,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -955,6 +985,8 @@ def get( Get activity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -973,6 +1005,8 @@ def get( request = models.CrmActivitiesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1079,6 +1113,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1092,6 +1128,8 @@ async def get_async( Get activity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1110,6 +1148,8 @@ async def get_async( request = models.CrmActivitiesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1217,6 +1257,8 @@ def update( *, id: str, type_: Nullable[models.ActivityType], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, activity_datetime: OptionalNullable[str] = UNSET, @@ -1284,6 +1326,8 @@ def update( :param id: ID of the record you are acting upon. :param type: The type of the activity + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param activity_datetime: The date and time of the activity @@ -1344,6 +1388,8 @@ def update( request = models.CrmActivitiesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, activity=models.ActivityInput( @@ -1507,6 +1553,8 @@ async def update_async( *, id: str, type_: Nullable[models.ActivityType], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, activity_datetime: OptionalNullable[str] = UNSET, @@ -1574,6 +1622,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param type: The type of the activity + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param activity_datetime: The date and time of the activity @@ -1634,6 +1684,8 @@ async def update_async( request = models.CrmActivitiesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, activity=models.ActivityInput( @@ -1796,6 +1848,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1808,6 +1862,8 @@ def delete( Delete activity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1825,6 +1881,8 @@ def delete( request = models.CrmActivitiesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1930,6 +1988,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1942,6 +2002,8 @@ async def delete_async( Delete activity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1959,6 +2021,8 @@ async def delete_async( request = models.CrmActivitiesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/ageddebtors_sdk.py b/src/apideck_unify/ageddebtors_sdk.py index fce84703..2d6e0c2e 100644 --- a/src/apideck_unify/ageddebtors_sdk.py +++ b/src/apideck_unify/ageddebtors_sdk.py @@ -13,6 +13,8 @@ def get( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.AgedReportFilter, models.AgedReportFilterTypedDict] @@ -29,6 +31,8 @@ def get( Get Aged Debtors :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -48,6 +52,8 @@ def get( request = models.AccountingAgedDebtorsOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model( filter_, Optional[models.AgedReportFilter] @@ -157,6 +163,8 @@ async def get_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.AgedReportFilter, models.AgedReportFilterTypedDict] @@ -173,6 +181,8 @@ async def get_async( Get Aged Debtors :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -192,6 +202,8 @@ async def get_async( request = models.AccountingAgedDebtorsOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model( filter_, Optional[models.AgedReportFilter] diff --git a/src/apideck_unify/apideck_companies.py b/src/apideck_unify/apideck_companies.py index d2ffedcd..33a52b00 100644 --- a/src/apideck_unify/apideck_companies.py +++ b/src/apideck_unify/apideck_companies.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Companies :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.HrisCompaniesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.HrisCompaniesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List Companies :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.HrisCompaniesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.HrisCompaniesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -341,6 +357,8 @@ def create( *, legal_name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_name: OptionalNullable[str] = UNSET, subdomain: OptionalNullable[str] = UNSET, @@ -372,6 +390,8 @@ def create( :param legal_name: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_name: :param subdomain: @@ -399,6 +419,8 @@ def create( request = models.HrisCompaniesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, hris_company=models.HrisCompanyInput( legal_name=legal_name, @@ -529,6 +551,8 @@ async def create_async( *, legal_name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_name: OptionalNullable[str] = UNSET, subdomain: OptionalNullable[str] = UNSET, @@ -560,6 +584,8 @@ async def create_async( :param legal_name: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_name: :param subdomain: @@ -587,6 +613,8 @@ async def create_async( request = models.HrisCompaniesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, hris_company=models.HrisCompanyInput( legal_name=legal_name, @@ -716,6 +744,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -729,6 +759,8 @@ def get( Get Company :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -747,6 +779,8 @@ def get( request = models.HrisCompaniesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -853,6 +887,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -866,6 +902,8 @@ async def get_async( Get Company :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -884,6 +922,8 @@ async def get_async( request = models.HrisCompaniesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -991,6 +1031,8 @@ def update( *, id: str, legal_name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_name: OptionalNullable[str] = UNSET, @@ -1023,6 +1065,8 @@ def update( :param id: ID of the record you are acting upon. :param legal_name: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_name: @@ -1051,6 +1095,8 @@ def update( request = models.HrisCompaniesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, hris_company=models.HrisCompanyInput( @@ -1182,6 +1228,8 @@ async def update_async( *, id: str, legal_name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_name: OptionalNullable[str] = UNSET, @@ -1214,6 +1262,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param legal_name: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_name: @@ -1242,6 +1292,8 @@ async def update_async( request = models.HrisCompaniesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, hris_company=models.HrisCompanyInput( @@ -1372,6 +1424,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1384,6 +1438,8 @@ def delete( Delete Company :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1401,6 +1457,8 @@ def delete( request = models.HrisCompaniesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1506,6 +1564,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1518,6 +1578,8 @@ async def delete_async( Delete Company :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1535,6 +1597,8 @@ async def delete_async( request = models.HrisCompaniesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/apideck_customers.py b/src/apideck_unify/apideck_customers.py index 14509f29..ccf71604 100644 --- a/src/apideck_unify/apideck_customers.py +++ b/src/apideck_unify/apideck_customers.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -35,6 +37,8 @@ def list( List Customers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -56,6 +60,8 @@ def list( request = models.EcommerceCustomersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -121,6 +127,8 @@ def next_func() -> Optional[models.EcommerceCustomersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -209,6 +219,8 @@ async def list_async( List Customers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -230,6 +242,8 @@ async def list_async( request = models.EcommerceCustomersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -295,6 +309,8 @@ def next_func() -> Optional[models.EcommerceCustomersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -362,6 +378,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -375,6 +393,8 @@ def get( Get Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -393,6 +413,8 @@ def get( request = models.EcommerceCustomersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -499,6 +521,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -512,6 +536,8 @@ async def get_async( Get Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -530,6 +556,8 @@ async def get_async( request = models.EcommerceCustomersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/apideck_departments.py b/src/apideck_unify/apideck_departments.py index 22ba321f..6fd715fb 100644 --- a/src/apideck_unify/apideck_departments.py +++ b/src/apideck_unify/apideck_departments.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Departments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.HrisDepartmentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.HrisDepartmentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List Departments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.HrisDepartmentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.HrisDepartmentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -340,6 +356,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: OptionalNullable[str] = UNSET, code: OptionalNullable[str] = UNSET, @@ -357,6 +375,8 @@ def create( Create Department :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: Department name :param code: @@ -377,6 +397,8 @@ def create( request = models.HrisDepartmentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, department=models.DepartmentInput( name=name, @@ -492,6 +514,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: OptionalNullable[str] = UNSET, code: OptionalNullable[str] = UNSET, @@ -509,6 +533,8 @@ async def create_async( Create Department :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: Department name :param code: @@ -529,6 +555,8 @@ async def create_async( request = models.HrisDepartmentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, department=models.DepartmentInput( name=name, @@ -644,6 +672,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -657,6 +687,8 @@ def get( Get Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -675,6 +707,8 @@ def get( request = models.HrisDepartmentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -781,6 +815,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -794,6 +830,8 @@ async def get_async( Get Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -812,6 +850,8 @@ async def get_async( request = models.HrisDepartmentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -918,6 +958,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: OptionalNullable[str] = UNSET, @@ -936,6 +978,8 @@ def update( Update Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: Department name @@ -957,6 +1001,8 @@ def update( request = models.HrisDepartmentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, department=models.DepartmentInput( @@ -1073,6 +1119,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: OptionalNullable[str] = UNSET, @@ -1091,6 +1139,8 @@ async def update_async( Update Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: Department name @@ -1112,6 +1162,8 @@ async def update_async( request = models.HrisDepartmentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, department=models.DepartmentInput( @@ -1228,6 +1280,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1240,6 +1294,8 @@ def delete( Delete Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1257,6 +1313,8 @@ def delete( request = models.HrisDepartmentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1362,6 +1420,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1374,6 +1434,8 @@ async def delete_async( Delete Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1391,6 +1453,8 @@ async def delete_async( request = models.HrisDepartmentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/apiresourcecoverage_sdk.py b/src/apideck_unify/apiresourcecoverage_sdk.py index 8ca8ca92..7a9a6f80 100644 --- a/src/apideck_unify/apiresourcecoverage_sdk.py +++ b/src/apideck_unify/apiresourcecoverage_sdk.py @@ -14,6 +14,7 @@ def get( *, id: str, resource_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -25,6 +26,7 @@ def get( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -39,6 +41,7 @@ def get( base_url = server_url request = models.ConnectorAPIResourceCoverageOneRequest( + app_id=app_id, id=id, resource_id=resource_id, ) @@ -138,6 +141,7 @@ async def get_async( *, id: str, resource_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -149,6 +153,7 @@ async def get_async( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -163,6 +168,7 @@ async def get_async( base_url = server_url request = models.ConnectorAPIResourceCoverageOneRequest( + app_id=app_id, id=id, resource_id=resource_id, ) diff --git a/src/apideck_unify/apiresources.py b/src/apideck_unify/apiresources.py index 8a47738b..cd31ef4c 100644 --- a/src/apideck_unify/apiresources.py +++ b/src/apideck_unify/apiresources.py @@ -14,6 +14,7 @@ def get( *, id: str, resource_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -25,6 +26,7 @@ def get( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -39,6 +41,7 @@ def get( base_url = server_url request = models.ConnectorAPIResourcesOneRequest( + app_id=app_id, id=id, resource_id=resource_id, ) @@ -138,6 +141,7 @@ async def get_async( *, id: str, resource_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -149,6 +153,7 @@ async def get_async( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -163,6 +168,7 @@ async def get_async( base_url = server_url request = models.ConnectorAPIResourcesOneRequest( + app_id=app_id, id=id, resource_id=resource_id, ) diff --git a/src/apideck_unify/apis.py b/src/apideck_unify/apis.py index 99c66eab..6143171d 100644 --- a/src/apideck_unify/apis.py +++ b/src/apideck_unify/apis.py @@ -13,6 +13,7 @@ class Apis(BaseSDK): def list( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[Union[models.ApisFilter, models.ApisFilterTypedDict]] = None, @@ -25,6 +26,7 @@ def list( List APIs + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Apply filters @@ -42,6 +44,7 @@ def list( base_url = server_url request = models.ConnectorApisAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model(filter_, Optional[models.ApisFilter]), @@ -100,6 +103,7 @@ def next_func() -> Optional[models.ConnectorApisAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, @@ -157,6 +161,7 @@ def next_func() -> Optional[models.ConnectorApisAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[Union[models.ApisFilter, models.ApisFilterTypedDict]] = None, @@ -169,6 +174,7 @@ async def list_async( List APIs + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Apply filters @@ -186,6 +192,7 @@ async def list_async( base_url = server_url request = models.ConnectorApisAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model(filter_, Optional[models.ApisFilter]), @@ -244,6 +251,7 @@ def next_func() -> Optional[models.ConnectorApisAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, @@ -302,6 +310,7 @@ def get( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -312,6 +321,7 @@ def get( Get API :param id: ID of the record you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -326,6 +336,7 @@ def get( base_url = server_url request = models.ConnectorApisOneRequest( + app_id=app_id, id=id, ) @@ -423,6 +434,7 @@ async def get_async( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -433,6 +445,7 @@ async def get_async( Get API :param id: ID of the record you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -447,6 +460,7 @@ async def get_async( base_url = server_url request = models.ConnectorApisOneRequest( + app_id=app_id, id=id, ) diff --git a/src/apideck_unify/applicants.py b/src/apideck_unify/applicants.py index a1aca700..33e423e1 100644 --- a/src/apideck_unify/applicants.py +++ b/src/apideck_unify/applicants.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( List Applicants :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -54,6 +58,8 @@ def list( request = models.AtsApplicantsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -119,6 +125,8 @@ def next_func() -> Optional[models.AtsApplicantsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -186,6 +194,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -204,6 +214,8 @@ async def list_async( List Applicants :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -225,6 +237,8 @@ async def list_async( request = models.AtsApplicantsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -290,6 +304,8 @@ def next_func() -> Optional[models.AtsApplicantsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -357,6 +373,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: Optional[str] = None, first_name: OptionalNullable[str] = UNSET, @@ -411,6 +429,8 @@ def create( Create Applicant :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: The name of an applicant. :param first_name: The first name of the person. @@ -458,6 +478,8 @@ def create( request = models.AtsApplicantsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, applicant=models.ApplicantInput( name=name, @@ -610,6 +632,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: Optional[str] = None, first_name: OptionalNullable[str] = UNSET, @@ -664,6 +688,8 @@ async def create_async( Create Applicant :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: The name of an applicant. :param first_name: The first name of the person. @@ -711,6 +737,8 @@ async def create_async( request = models.AtsApplicantsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, applicant=models.ApplicantInput( name=name, @@ -863,6 +891,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -876,6 +906,8 @@ def get( Get Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -894,6 +926,8 @@ def get( request = models.AtsApplicantsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1000,6 +1034,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1013,6 +1049,8 @@ async def get_async( Get Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1031,6 +1069,8 @@ async def get_async( request = models.AtsApplicantsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1137,6 +1177,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -1192,6 +1234,8 @@ def update( Update Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of an applicant. @@ -1240,6 +1284,8 @@ def update( request = models.AtsApplicantsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, applicant=models.ApplicantInput( @@ -1393,6 +1439,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -1448,6 +1496,8 @@ async def update_async( Update Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of an applicant. @@ -1496,6 +1546,8 @@ async def update_async( request = models.AtsApplicantsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, applicant=models.ApplicantInput( @@ -1649,6 +1701,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1661,6 +1715,8 @@ def delete( Delete Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1678,6 +1734,8 @@ def delete( request = models.AtsApplicantsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1783,6 +1841,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1795,6 +1855,8 @@ async def delete_async( Delete Applicant :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1812,6 +1874,8 @@ async def delete_async( request = models.AtsApplicantsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/applications.py b/src/apideck_unify/applications.py index a599fc0b..52eca305 100644 --- a/src/apideck_unify/applications.py +++ b/src/apideck_unify/applications.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, pass_through: Optional[Dict[str, Any]] = None, @@ -28,6 +30,8 @@ def list( List Applications :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -47,6 +51,8 @@ def list( request = models.AtsApplicationsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, pass_through=pass_through, @@ -108,6 +114,8 @@ def next_func() -> Optional[models.AtsApplicationsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, pass_through=pass_through, @@ -173,6 +181,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, pass_through: Optional[Dict[str, Any]] = None, @@ -187,6 +197,8 @@ async def list_async( List Applications :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -206,6 +218,8 @@ async def list_async( request = models.AtsApplicationsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, pass_through=pass_through, @@ -267,6 +281,8 @@ def next_func() -> Optional[models.AtsApplicationsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, pass_through=pass_through, @@ -334,6 +350,8 @@ def create( applicant_id: Nullable[str], job_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, status: OptionalNullable[models.ApplicationStatus] = UNSET, stage: Optional[Union[models.Stage, models.StageTypedDict]] = None, @@ -352,6 +370,8 @@ def create( :param applicant_id: :param job_id: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param status: :param stage: @@ -371,6 +391,8 @@ def create( request = models.AtsApplicationsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, application=models.ApplicationInput( applicant_id=applicant_id, @@ -489,6 +511,8 @@ async def create_async( applicant_id: Nullable[str], job_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, status: OptionalNullable[models.ApplicationStatus] = UNSET, stage: Optional[Union[models.Stage, models.StageTypedDict]] = None, @@ -507,6 +531,8 @@ async def create_async( :param applicant_id: :param job_id: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param status: :param stage: @@ -526,6 +552,8 @@ async def create_async( request = models.AtsApplicationsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, application=models.ApplicationInput( applicant_id=applicant_id, @@ -642,6 +670,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -654,6 +684,8 @@ def get( Get Application :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -671,6 +703,8 @@ def get( request = models.AtsApplicationsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -776,6 +810,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -788,6 +824,8 @@ async def get_async( Get Application :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -805,6 +843,8 @@ async def get_async( request = models.AtsApplicationsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -912,6 +952,8 @@ def update( id: str, applicant_id: Nullable[str], job_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, status: OptionalNullable[models.ApplicationStatus] = UNSET, @@ -931,6 +973,8 @@ def update( :param id: ID of the record you are acting upon. :param applicant_id: :param job_id: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param status: @@ -951,6 +995,8 @@ def update( request = models.AtsApplicationsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, application=models.ApplicationInput( @@ -1070,6 +1116,8 @@ async def update_async( id: str, applicant_id: Nullable[str], job_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, status: OptionalNullable[models.ApplicationStatus] = UNSET, @@ -1089,6 +1137,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param applicant_id: :param job_id: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param status: @@ -1109,6 +1159,8 @@ async def update_async( request = models.AtsApplicationsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, application=models.ApplicationInput( @@ -1226,6 +1278,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1238,6 +1292,8 @@ def delete( Delete Application :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1255,6 +1311,8 @@ def delete( request = models.AtsApplicationsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1360,6 +1418,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1372,6 +1432,8 @@ async def delete_async( Delete Application :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1389,6 +1451,8 @@ async def delete_async( request = models.AtsApplicationsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/attachments.py b/src/apideck_unify/attachments.py index f92a3414..dd58aebd 100644 --- a/src/apideck_unify/attachments.py +++ b/src/apideck_unify/attachments.py @@ -22,6 +22,8 @@ def list( reference_type: models.AttachmentReferenceType, reference_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -38,6 +40,8 @@ def list( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -59,6 +63,8 @@ def list( reference_type=reference_type, reference_id=reference_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -122,6 +128,8 @@ def next_func() -> Optional[models.AccountingAttachmentsAllResponse]: reference_type=reference_type, reference_id=reference_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -189,6 +197,8 @@ async def list_async( reference_type: models.AttachmentReferenceType, reference_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -205,6 +215,8 @@ async def list_async( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -226,6 +238,8 @@ async def list_async( reference_type=reference_type, reference_id=reference_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -289,6 +303,8 @@ def next_func() -> Optional[models.AccountingAttachmentsAllResponse]: reference_type=reference_type, reference_id=reference_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -356,6 +372,8 @@ def get( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -371,6 +389,8 @@ def get( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -391,6 +411,8 @@ def get( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -499,6 +521,8 @@ async def get_async( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -514,6 +538,8 @@ async def get_async( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -534,6 +560,8 @@ async def get_async( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -642,6 +670,8 @@ def delete( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -656,6 +686,8 @@ def delete( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -675,6 +707,8 @@ def delete( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -782,6 +816,8 @@ async def delete_async( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -796,6 +832,8 @@ async def delete_async( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -815,6 +853,8 @@ async def delete_async( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -922,6 +962,8 @@ def download( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -937,6 +979,8 @@ def download( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -957,6 +1001,8 @@ def download( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -1071,6 +1117,8 @@ async def download_async( reference_type: models.AttachmentReferenceType, reference_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1086,6 +1134,8 @@ async def download_async( :param reference_type: The reference type of the document. :param reference_id: The reference id of the object to retrieve. :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1106,6 +1156,8 @@ async def download_async( reference_type=reference_type, reference_id=reference_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) diff --git a/src/apideck_unify/balancesheet_sdk.py b/src/apideck_unify/balancesheet_sdk.py index 77c723ff..2fa3b4d8 100644 --- a/src/apideck_unify/balancesheet_sdk.py +++ b/src/apideck_unify/balancesheet_sdk.py @@ -12,6 +12,8 @@ class BalanceSheetSDK(BaseSDK): def get( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through: Optional[Dict[str, Any]] = None, filter_: Optional[ @@ -27,6 +29,8 @@ def get( Get BalanceSheet + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param filter_: Apply filters @@ -45,6 +49,8 @@ def get( base_url = server_url request = models.AccountingBalanceSheetOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through=pass_through, filter_=utils.get_pydantic_model( @@ -153,6 +159,8 @@ def get( async def get_async( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through: Optional[Dict[str, Any]] = None, filter_: Optional[ @@ -168,6 +176,8 @@ async def get_async( Get BalanceSheet + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param filter_: Apply filters @@ -186,6 +196,8 @@ async def get_async( base_url = server_url request = models.AccountingBalanceSheetOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through=pass_through, filter_=utils.get_pydantic_model( diff --git a/src/apideck_unify/billpayments.py b/src/apideck_unify/billpayments.py index fd7ab0ca..4f48b727 100644 --- a/src/apideck_unify/billpayments.py +++ b/src/apideck_unify/billpayments.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Bill Payments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -56,6 +60,8 @@ def list( request = models.AccountingBillPaymentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -120,6 +126,8 @@ def next_func() -> Optional[models.AccountingBillPaymentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -207,6 +217,8 @@ async def list_async( List Bill Payments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -229,6 +241,8 @@ async def list_async( request = models.AccountingBillPaymentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -293,6 +307,8 @@ def next_func() -> Optional[models.AccountingBillPaymentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -363,6 +379,8 @@ def create( total_amount: Nullable[float], transaction_date: Nullable[datetime], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -417,6 +435,8 @@ def create( :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -453,6 +473,8 @@ def create( request = models.AccountingBillPaymentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, bill_payment=models.BillPaymentInput( currency=currency, @@ -599,6 +621,8 @@ async def create_async( total_amount: Nullable[float], transaction_date: Nullable[datetime], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -653,6 +677,8 @@ async def create_async( :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -689,6 +715,8 @@ async def create_async( request = models.AccountingBillPaymentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, bill_payment=models.BillPaymentInput( currency=currency, @@ -833,6 +861,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -846,6 +876,8 @@ def get( Get Bill Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -864,6 +896,8 @@ def get( request = models.AccountingBillPaymentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -970,6 +1004,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -983,6 +1019,8 @@ async def get_async( Get Bill Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1001,6 +1039,8 @@ async def get_async( request = models.AccountingBillPaymentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1109,6 +1149,8 @@ def update( id: str, total_amount: Nullable[float], transaction_date: Nullable[datetime], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, currency: OptionalNullable[models.Currency] = UNSET, @@ -1164,6 +1206,8 @@ def update( :param id: ID of the record you are acting upon. :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1201,6 +1245,8 @@ def update( request = models.AccountingBillPaymentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, bill_payment=models.BillPaymentInput( @@ -1348,6 +1394,8 @@ async def update_async( id: str, total_amount: Nullable[float], transaction_date: Nullable[datetime], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, currency: OptionalNullable[models.Currency] = UNSET, @@ -1403,6 +1451,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1440,6 +1490,8 @@ async def update_async( request = models.AccountingBillPaymentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, bill_payment=models.BillPaymentInput( @@ -1585,6 +1637,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1597,6 +1651,8 @@ def delete( Delete Bill Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1614,6 +1670,8 @@ def delete( request = models.AccountingBillPaymentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1719,6 +1777,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1731,6 +1791,8 @@ async def delete_async( Delete Bill Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1748,6 +1810,8 @@ async def delete_async( request = models.AccountingBillPaymentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/bills.py b/src/apideck_unify/bills.py index aa1d5113..919d429a 100644 --- a/src/apideck_unify/bills.py +++ b/src/apideck_unify/bills.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Bills :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -56,6 +60,8 @@ def list( request = models.AccountingBillsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -120,6 +126,8 @@ def next_func() -> Optional[models.AccountingBillsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -207,6 +217,8 @@ async def list_async( List Bills :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -229,6 +241,8 @@ async def list_async( request = models.AccountingBillsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -293,6 +307,8 @@ def next_func() -> Optional[models.AccountingBillsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -361,6 +377,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ @@ -427,6 +445,8 @@ def create( Create Bill :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. @@ -476,6 +496,8 @@ def create( request = models.AccountingBillsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, bill=models.BillInput( bill_number=bill_number, @@ -633,6 +655,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, bill_number: OptionalNullable[str] = UNSET, supplier: OptionalNullable[ @@ -699,6 +723,8 @@ async def create_async( Create Bill :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param bill_number: Reference to supplier bill number :param supplier: The supplier this entity is linked to. @@ -748,6 +774,8 @@ async def create_async( request = models.AccountingBillsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, bill=models.BillInput( bill_number=bill_number, @@ -905,6 +933,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -918,6 +948,8 @@ def get( Get Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -936,6 +968,8 @@ def get( request = models.AccountingBillsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1042,6 +1076,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1055,6 +1091,8 @@ async def get_async( Get Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1073,6 +1111,8 @@ async def get_async( request = models.AccountingBillsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1179,6 +1219,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, bill_number: OptionalNullable[str] = UNSET, @@ -1246,6 +1288,8 @@ def update( Update Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param bill_number: Reference to supplier bill number @@ -1296,6 +1340,8 @@ def update( request = models.AccountingBillsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, bill=models.BillInput( @@ -1454,6 +1500,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, bill_number: OptionalNullable[str] = UNSET, @@ -1521,6 +1569,8 @@ async def update_async( Update Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param bill_number: Reference to supplier bill number @@ -1571,6 +1621,8 @@ async def update_async( request = models.AccountingBillsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, bill=models.BillInput( @@ -1729,6 +1781,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1741,6 +1795,8 @@ def delete( Delete Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1758,6 +1814,8 @@ def delete( request = models.AccountingBillsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1863,6 +1921,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1875,6 +1935,8 @@ async def delete_async( Delete Bill :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1892,6 +1954,8 @@ async def delete_async( request = models.AccountingBillsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/collections.py b/src/apideck_unify/collections.py index 983c392f..6c75a999 100644 --- a/src/apideck_unify/collections.py +++ b/src/apideck_unify/collections.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -32,6 +34,8 @@ def list( List Collections :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -53,6 +57,8 @@ def list( request = models.IssueTrackingCollectionsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -116,6 +122,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -183,6 +191,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -201,6 +211,8 @@ async def list_async( List Collections :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -222,6 +234,8 @@ async def list_async( request = models.IssueTrackingCollectionsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -285,6 +299,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -352,6 +368,8 @@ def get( self, *, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -365,6 +383,8 @@ def get( Get Collection :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -383,6 +403,8 @@ def get( request = models.IssueTrackingCollectionsOneRequest( collection_id=collection_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -489,6 +511,8 @@ async def get_async( self, *, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -502,6 +526,8 @@ async def get_async( Get Collection :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -520,6 +546,8 @@ async def get_async( request = models.IssueTrackingCollectionsOneRequest( collection_id=collection_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/collectiontags.py b/src/apideck_unify/collectiontags.py index 2df59fb6..d6ad34cb 100644 --- a/src/apideck_unify/collectiontags.py +++ b/src/apideck_unify/collectiontags.py @@ -15,6 +15,8 @@ def list( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -31,6 +33,8 @@ def list( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -52,6 +56,8 @@ def list( request = models.IssueTrackingCollectionTagsAllRequest( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -115,6 +121,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionTagsAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -182,6 +190,8 @@ async def list_async( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -198,6 +208,8 @@ async def list_async( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -219,6 +231,8 @@ async def list_async( request = models.IssueTrackingCollectionTagsAllRequest( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -282,6 +296,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionTagsAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, diff --git a/src/apideck_unify/collectionticketcomments.py b/src/apideck_unify/collectionticketcomments.py index c6352098..e8324fe8 100644 --- a/src/apideck_unify/collectionticketcomments.py +++ b/src/apideck_unify/collectionticketcomments.py @@ -16,6 +16,8 @@ def list( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -55,6 +59,8 @@ def list( request = models.IssueTrackingCollectionTicketCommentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> ( collection_id=collection_id, ticket_id=ticket_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -193,6 +201,8 @@ async def list_async( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -211,6 +221,8 @@ async def list_async( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -232,6 +244,8 @@ async def list_async( request = models.IssueTrackingCollectionTicketCommentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> ( collection_id=collection_id, ticket_id=ticket_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -370,6 +386,8 @@ def create( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, body: OptionalNullable[str] = UNSET, pass_through: Optional[ @@ -387,6 +405,8 @@ def create( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param body: Body of the comment :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -405,6 +425,8 @@ def create( request = models.IssueTrackingCollectionTicketCommentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, collection_id=collection_id, ticket_id=ticket_id, @@ -526,6 +548,8 @@ async def create_async( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, body: OptionalNullable[str] = UNSET, pass_through: Optional[ @@ -543,6 +567,8 @@ async def create_async( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param body: Body of the comment :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -561,6 +587,8 @@ async def create_async( request = models.IssueTrackingCollectionTicketCommentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, collection_id=collection_id, ticket_id=ticket_id, @@ -683,6 +711,8 @@ def get( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -700,6 +730,8 @@ def get( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -720,6 +752,8 @@ def get( request = models.IssueTrackingCollectionTicketCommentsOneRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -788,6 +822,8 @@ def next_func() -> ( collection_id=collection_id, ticket_id=ticket_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -856,6 +892,8 @@ async def get_async( collection_id: str, ticket_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -873,6 +911,8 @@ async def get_async( :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -893,6 +933,8 @@ async def get_async( request = models.IssueTrackingCollectionTicketCommentsOneRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -961,6 +1003,8 @@ def next_func() -> ( collection_id=collection_id, ticket_id=ticket_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -1028,6 +1072,8 @@ def update( id: str, collection_id: str, ticket_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, body: OptionalNullable[str] = UNSET, @@ -1046,6 +1092,8 @@ def update( :param id: ID of the record you are acting upon. :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param body: Body of the comment @@ -1065,6 +1113,8 @@ def update( request = models.IssueTrackingCollectionTicketCommentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1187,6 +1237,8 @@ async def update_async( id: str, collection_id: str, ticket_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, body: OptionalNullable[str] = UNSET, @@ -1205,6 +1257,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param body: Body of the comment @@ -1224,6 +1278,8 @@ async def update_async( request = models.IssueTrackingCollectionTicketCommentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1346,6 +1402,8 @@ def delete( id: str, collection_id: str, ticket_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1360,6 +1418,8 @@ def delete( :param id: ID of the record you are acting upon. :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1377,6 +1437,8 @@ def delete( request = models.IssueTrackingCollectionTicketCommentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1486,6 +1548,8 @@ async def delete_async( id: str, collection_id: str, ticket_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1500,6 +1564,8 @@ async def delete_async( :param id: ID of the record you are acting upon. :param collection_id: The collection ID :param ticket_id: ID of the ticket you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1517,6 +1583,8 @@ async def delete_async( request = models.IssueTrackingCollectionTicketCommentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, diff --git a/src/apideck_unify/collectiontickets.py b/src/apideck_unify/collectiontickets.py index b1761065..c119462a 100644 --- a/src/apideck_unify/collectiontickets.py +++ b/src/apideck_unify/collectiontickets.py @@ -16,6 +16,8 @@ def list( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.IssueTrackingCollectionTicketsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionTicketsAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -193,6 +201,8 @@ async def list_async( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -213,6 +223,8 @@ async def list_async( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -235,6 +247,8 @@ async def list_async( request = models.IssueTrackingCollectionTicketsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionTicketsAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -370,6 +386,8 @@ def create( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[str] = UNSET, @@ -401,6 +419,8 @@ def create( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: The ticket's parent ID :param type: The ticket's type @@ -427,6 +447,8 @@ def create( request = models.IssueTrackingCollectionTicketsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, collection_id=collection_id, ticket=models.TicketInput( @@ -554,6 +576,8 @@ async def create_async( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[str] = UNSET, @@ -585,6 +609,8 @@ async def create_async( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: The ticket's parent ID :param type: The ticket's type @@ -611,6 +637,8 @@ async def create_async( request = models.IssueTrackingCollectionTicketsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, collection_id=collection_id, ticket=models.TicketInput( @@ -738,6 +766,8 @@ def get( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -752,6 +782,8 @@ def get( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -770,6 +802,8 @@ def get( request = models.IssueTrackingCollectionTicketsOneRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -878,6 +912,8 @@ async def get_async( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -892,6 +928,8 @@ async def get_async( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -910,6 +948,8 @@ async def get_async( request = models.IssueTrackingCollectionTicketsOneRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1018,6 +1058,8 @@ def update( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1050,6 +1092,8 @@ def update( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: The ticket's parent ID @@ -1077,6 +1121,8 @@ def update( request = models.IssueTrackingCollectionTicketsUpdateRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1205,6 +1251,8 @@ async def update_async( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1237,6 +1285,8 @@ async def update_async( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: The ticket's parent ID @@ -1264,6 +1314,8 @@ async def update_async( request = models.IssueTrackingCollectionTicketsUpdateRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1392,6 +1444,8 @@ def delete( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1405,6 +1459,8 @@ def delete( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1422,6 +1478,8 @@ def delete( request = models.IssueTrackingCollectionTicketsDeleteRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, @@ -1529,6 +1587,8 @@ async def delete_async( *, ticket_id: str, collection_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1542,6 +1602,8 @@ async def delete_async( :param ticket_id: ID of the ticket you are acting upon. :param collection_id: The collection ID + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1559,6 +1621,8 @@ async def delete_async( request = models.IssueTrackingCollectionTicketsDeleteRequest( ticket_id=ticket_id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, collection_id=collection_id, diff --git a/src/apideck_unify/collectionusers.py b/src/apideck_unify/collectionusers.py index 18c60c6d..a6b60daf 100644 --- a/src/apideck_unify/collectionusers.py +++ b/src/apideck_unify/collectionusers.py @@ -15,6 +15,8 @@ def list( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -31,6 +33,8 @@ def list( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -52,6 +56,8 @@ def list( request = models.IssueTrackingCollectionUsersAllRequest( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -115,6 +121,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionUsersAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -182,6 +190,8 @@ async def list_async( *, collection_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -198,6 +208,8 @@ async def list_async( :param collection_id: The collection ID :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -219,6 +231,8 @@ async def list_async( request = models.IssueTrackingCollectionUsersAllRequest( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -282,6 +296,8 @@ def next_func() -> Optional[models.IssueTrackingCollectionUsersAllResponse]: return self.list( collection_id=collection_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -349,6 +365,8 @@ def get( *, collection_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -363,6 +381,8 @@ def get( :param collection_id: The collection ID :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -382,6 +402,8 @@ def get( request = models.IssueTrackingCollectionUsersOneRequest( collection_id=collection_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -489,6 +511,8 @@ async def get_async( *, collection_id: str, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -503,6 +527,8 @@ async def get_async( :param collection_id: The collection ID :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -522,6 +548,8 @@ async def get_async( request = models.IssueTrackingCollectionUsersOneRequest( collection_id=collection_id, id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/companies.py b/src/apideck_unify/companies.py index fc860528..ea695410 100644 --- a/src/apideck_unify/companies.py +++ b/src/apideck_unify/companies.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( List companies :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.CrmCompaniesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -122,6 +128,8 @@ def next_func() -> Optional[models.CrmCompaniesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -190,6 +198,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -211,6 +221,8 @@ async def list_async( List companies :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -233,6 +245,8 @@ async def list_async( request = models.CrmCompaniesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -297,6 +311,8 @@ def next_func() -> Optional[models.CrmCompaniesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -366,6 +382,8 @@ def create( *, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, image: OptionalNullable[str] = UNSET, @@ -425,6 +443,8 @@ def create( :param name: Name of the company :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: Owner ID :param image: The Image URL of the company @@ -472,6 +492,8 @@ def create( request = models.CrmCompaniesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, company=models.CompanyInput( name=name, @@ -630,6 +652,8 @@ async def create_async( *, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, image: OptionalNullable[str] = UNSET, @@ -689,6 +713,8 @@ async def create_async( :param name: Name of the company :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: Owner ID :param image: The Image URL of the company @@ -736,6 +762,8 @@ async def create_async( request = models.CrmCompaniesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, company=models.CompanyInput( name=name, @@ -894,6 +922,8 @@ def get( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -907,6 +937,8 @@ def get( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -925,6 +957,8 @@ def get( request = models.CrmCompaniesOneRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -1031,6 +1065,8 @@ async def get_async( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1044,6 +1080,8 @@ async def get_async( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1062,6 +1100,8 @@ async def get_async( request = models.CrmCompaniesOneRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -1169,6 +1209,8 @@ def update( id: str, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, image: OptionalNullable[str] = UNSET, @@ -1229,6 +1271,8 @@ def update( :param id: ID of the record you are acting upon. :param name: Name of the company :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: Owner ID :param image: The Image URL of the company @@ -1277,6 +1321,8 @@ def update( request = models.CrmCompaniesUpdateRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, company=models.CompanyInput( name=name, @@ -1436,6 +1482,8 @@ async def update_async( id: str, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, image: OptionalNullable[str] = UNSET, @@ -1496,6 +1544,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param name: Name of the company :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: Owner ID :param image: The Image URL of the company @@ -1544,6 +1594,8 @@ async def update_async( request = models.CrmCompaniesUpdateRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, company=models.CompanyInput( name=name, @@ -1702,6 +1754,8 @@ def delete( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -1714,6 +1768,8 @@ def delete( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1731,6 +1787,8 @@ def delete( request = models.CrmCompaniesDeleteRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, ) @@ -1836,6 +1894,8 @@ async def delete_async( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -1848,6 +1908,8 @@ async def delete_async( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1865,6 +1927,8 @@ async def delete_async( request = models.CrmCompaniesDeleteRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, ) diff --git a/src/apideck_unify/companyinfo_sdk.py b/src/apideck_unify/companyinfo_sdk.py index cabeaebb..d0a559d3 100644 --- a/src/apideck_unify/companyinfo_sdk.py +++ b/src/apideck_unify/companyinfo_sdk.py @@ -13,6 +13,8 @@ def get( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -25,6 +27,8 @@ def get( Get company info :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -42,6 +46,8 @@ def get( request = models.AccountingCompanyInfoOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -147,6 +153,8 @@ async def get_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -159,6 +167,8 @@ async def get_async( Get company info :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -176,6 +186,8 @@ async def get_async( request = models.AccountingCompanyInfoOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) diff --git a/src/apideck_unify/connectioncustommappings.py b/src/apideck_unify/connectioncustommappings.py index a51c7566..bc4845c5 100644 --- a/src/apideck_unify/connectioncustommappings.py +++ b/src/apideck_unify/connectioncustommappings.py @@ -15,6 +15,8 @@ def list( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, resource_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -28,6 +30,8 @@ def list( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param resource_id: This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -43,6 +47,8 @@ def list( base_url = server_url request = models.VaultConnectionCustomMappingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, @@ -152,6 +158,8 @@ async def list_async( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, resource_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -165,6 +173,8 @@ async def list_async( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param resource_id: This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -180,6 +190,8 @@ async def list_async( base_url = server_url request = models.VaultConnectionCustomMappingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, diff --git a/src/apideck_unify/connections.py b/src/apideck_unify/connections.py index 2ee9d0c0..b8d2a83e 100644 --- a/src/apideck_unify/connections.py +++ b/src/apideck_unify/connections.py @@ -12,6 +12,8 @@ class Connections(BaseSDK): def list( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, api: Optional[str] = None, configured: Optional[bool] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -26,6 +28,8 @@ def list( OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param api: Scope results to Unified API :param configured: Scopes results to connections that have been configured or not :param retries: Override the default retry configuration for this method @@ -42,6 +46,8 @@ def list( base_url = server_url request = models.VaultConnectionsAllRequest( + consumer_id=consumer_id, + app_id=app_id, api=api, configured=configured, ) @@ -146,6 +152,8 @@ def list( async def list_async( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, api: Optional[str] = None, configured: Optional[bool] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -160,6 +168,8 @@ async def list_async( OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param api: Scope results to Unified API :param configured: Scopes results to connections that have been configured or not :param retries: Override the default retry configuration for this method @@ -176,6 +186,8 @@ async def list_async( base_url = server_url request = models.VaultConnectionsAllRequest( + consumer_id=consumer_id, + app_id=app_id, api=api, configured=configured, ) @@ -282,6 +294,8 @@ def get( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -293,6 +307,8 @@ def get( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -307,6 +323,8 @@ def get( base_url = server_url request = models.VaultConnectionsOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, ) @@ -413,6 +431,8 @@ async def get_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -424,6 +444,8 @@ async def get_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -438,6 +460,8 @@ async def get_async( base_url = server_url request = models.VaultConnectionsOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, ) @@ -544,6 +568,8 @@ def update( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, enabled: Optional[bool] = None, settings: OptionalNullable[Dict[str, Any]] = UNSET, metadata: OptionalNullable[Dict[str, Any]] = UNSET, @@ -570,6 +596,8 @@ def update( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param enabled: Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -589,6 +617,8 @@ def update( base_url = server_url request = models.VaultConnectionsUpdateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, connection=models.ConnectionInput( @@ -709,6 +739,8 @@ async def update_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, enabled: Optional[bool] = None, settings: OptionalNullable[Dict[str, Any]] = UNSET, metadata: OptionalNullable[Dict[str, Any]] = UNSET, @@ -735,6 +767,8 @@ async def update_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param enabled: Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -754,6 +788,8 @@ async def update_async( base_url = server_url request = models.VaultConnectionsUpdateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, connection=models.ConnectionInput( @@ -874,6 +910,8 @@ def delete( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -885,6 +923,8 @@ def delete( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -899,6 +939,8 @@ def delete( base_url = server_url request = models.VaultConnectionsDeleteRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, ) @@ -1002,6 +1044,8 @@ async def delete_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1013,6 +1057,8 @@ async def delete_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1027,6 +1073,8 @@ async def delete_async( base_url = server_url request = models.VaultConnectionsDeleteRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, ) @@ -1130,6 +1178,8 @@ def imports( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, credentials: Optional[ Union[models.Credentials, models.CredentialsTypedDict] ] = None, @@ -1152,6 +1202,8 @@ def imports( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param credentials: :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -1169,6 +1221,8 @@ def imports( base_url = server_url request = models.VaultConnectionsImportRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, connection_import_data=models.ConnectionImportData( @@ -1291,6 +1345,8 @@ async def imports_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, credentials: Optional[ Union[models.Credentials, models.CredentialsTypedDict] ] = None, @@ -1313,6 +1369,8 @@ async def imports_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param credentials: :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -1330,6 +1388,8 @@ async def imports_async( base_url = server_url request = models.VaultConnectionsImportRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, connection_import_data=models.ConnectionImportData( @@ -1452,6 +1512,8 @@ def token( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, request_body: Optional[ Union[ models.VaultConnectionsTokenRequestBody, @@ -1475,6 +1537,8 @@ def token( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param request_body: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1490,6 +1554,8 @@ def token( base_url = server_url request = models.VaultConnectionsTokenRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, request_body=utils.get_pydantic_model( @@ -1606,6 +1672,8 @@ async def token_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, request_body: Optional[ Union[ models.VaultConnectionsTokenRequestBody, @@ -1629,6 +1697,8 @@ async def token_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param request_body: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1644,6 +1714,8 @@ async def token_async( base_url = server_url request = models.VaultConnectionsTokenRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, request_body=utils.get_pydantic_model( diff --git a/src/apideck_unify/connectionsettings.py b/src/apideck_unify/connectionsettings.py index cbcfd167..6cd9a4fd 100644 --- a/src/apideck_unify/connectionsettings.py +++ b/src/apideck_unify/connectionsettings.py @@ -15,6 +15,8 @@ def list( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -28,6 +30,8 @@ def list( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -42,6 +46,8 @@ def list( base_url = server_url request = models.VaultConnectionSettingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, @@ -150,6 +156,8 @@ async def list_async( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -163,6 +171,8 @@ async def list_async( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -177,6 +187,8 @@ async def list_async( base_url = server_url request = models.VaultConnectionSettingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, @@ -285,6 +297,8 @@ def update( service_id: str, unified_api: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, enabled: Optional[bool] = None, settings: OptionalNullable[Dict[str, Any]] = UNSET, metadata: OptionalNullable[Dict[str, Any]] = UNSET, @@ -312,6 +326,8 @@ def update( :param service_id: Service ID of the resource to return :param unified_api: Unified API :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param enabled: Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -331,6 +347,8 @@ def update( base_url = server_url request = models.VaultConnectionSettingsUpdateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, resource=resource, @@ -453,6 +471,8 @@ async def update_async( service_id: str, unified_api: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, enabled: Optional[bool] = None, settings: OptionalNullable[Dict[str, Any]] = UNSET, metadata: OptionalNullable[Dict[str, Any]] = UNSET, @@ -480,6 +500,8 @@ async def update_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param enabled: Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. :param settings: Connection settings. Values will persist to `form_fields` with corresponding id :param metadata: Attach your own consumer specific metadata @@ -499,6 +521,8 @@ async def update_async( base_url = server_url request = models.VaultConnectionSettingsUpdateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, resource=resource, diff --git a/src/apideck_unify/connectordocs.py b/src/apideck_unify/connectordocs.py index 0b0f3847..57373a78 100644 --- a/src/apideck_unify/connectordocs.py +++ b/src/apideck_unify/connectordocs.py @@ -20,6 +20,7 @@ def get( *, id: str, doc_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -32,6 +33,7 @@ def get( :param id: ID of the record you are acting upon. :param doc_id: ID of the Doc + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -47,6 +49,7 @@ def get( base_url = server_url request = models.ConnectorConnectorDocsOneRequest( + app_id=app_id, id=id, doc_id=doc_id, ) @@ -146,6 +149,7 @@ async def get_async( *, id: str, doc_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -158,6 +162,7 @@ async def get_async( :param id: ID of the record you are acting upon. :param doc_id: ID of the Doc + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -173,6 +178,7 @@ async def get_async( base_url = server_url request = models.ConnectorConnectorDocsOneRequest( + app_id=app_id, id=id, doc_id=doc_id, ) diff --git a/src/apideck_unify/connectorresources.py b/src/apideck_unify/connectorresources.py index f0923897..93759f25 100644 --- a/src/apideck_unify/connectorresources.py +++ b/src/apideck_unify/connectorresources.py @@ -14,6 +14,7 @@ def get( *, id: str, resource_id: str, + app_id: Optional[str] = None, unified_api: Optional[models.UnifiedAPIID] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -26,6 +27,7 @@ def get( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param unified_api: Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -41,6 +43,7 @@ def get( base_url = server_url request = models.ConnectorConnectorResourcesOneRequest( + app_id=app_id, id=id, resource_id=resource_id, unified_api=unified_api, @@ -141,6 +144,7 @@ async def get_async( *, id: str, resource_id: str, + app_id: Optional[str] = None, unified_api: Optional[models.UnifiedAPIID] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -153,6 +157,7 @@ async def get_async( :param id: ID of the record you are acting upon. :param resource_id: ID of the resource you are acting upon. + :param app_id: The ID of your Unify application :param unified_api: Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -168,6 +173,7 @@ async def get_async( base_url = server_url request = models.ConnectorConnectorResourcesOneRequest( + app_id=app_id, id=id, resource_id=resource_id, unified_api=unified_api, diff --git a/src/apideck_unify/connectors.py b/src/apideck_unify/connectors.py index a4d64d88..a0989903 100644 --- a/src/apideck_unify/connectors.py +++ b/src/apideck_unify/connectors.py @@ -13,6 +13,7 @@ class Connectors(BaseSDK): def list( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[ @@ -27,6 +28,7 @@ def list( List Connectors + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Apply filters @@ -44,6 +46,7 @@ def list( base_url = server_url request = models.ConnectorConnectorsAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model( @@ -104,6 +107,7 @@ def next_func() -> Optional[models.ConnectorConnectorsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, @@ -161,6 +165,7 @@ def next_func() -> Optional[models.ConnectorConnectorsAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[ @@ -175,6 +180,7 @@ async def list_async( List Connectors + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Apply filters @@ -192,6 +198,7 @@ async def list_async( base_url = server_url request = models.ConnectorConnectorsAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model( @@ -252,6 +259,7 @@ def next_func() -> Optional[models.ConnectorConnectorsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, @@ -310,6 +318,7 @@ def get( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -320,6 +329,7 @@ def get( Get Connector :param id: ID of the record you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -334,6 +344,7 @@ def get( base_url = server_url request = models.ConnectorConnectorsOneRequest( + app_id=app_id, id=id, ) @@ -431,6 +442,7 @@ async def get_async( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -441,6 +453,7 @@ async def get_async( Get Connector :param id: ID of the record you are acting upon. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -455,6 +468,7 @@ async def get_async( base_url = server_url request = models.ConnectorConnectorsOneRequest( + app_id=app_id, id=id, ) diff --git a/src/apideck_unify/consumerrequestcounts.py b/src/apideck_unify/consumerrequestcounts.py index 7c2a3605..11f4a23c 100644 --- a/src/apideck_unify/consumerrequestcounts.py +++ b/src/apideck_unify/consumerrequestcounts.py @@ -15,6 +15,7 @@ def list( consumer_id: str, start_datetime: str, end_datetime: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -28,6 +29,7 @@ def list( :param consumer_id: ID of the consumer to return :param start_datetime: Scopes results to requests that happened after datetime :param end_datetime: Scopes results to requests that happened before datetime + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -42,6 +44,7 @@ def list( base_url = server_url request = models.VaultConsumerRequestCountsAllRequest( + app_id=app_id, consumer_id=consumer_id, start_datetime=start_datetime, end_datetime=end_datetime, @@ -150,6 +153,7 @@ async def list_async( consumer_id: str, start_datetime: str, end_datetime: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -163,6 +167,7 @@ async def list_async( :param consumer_id: ID of the consumer to return :param start_datetime: Scopes results to requests that happened after datetime :param end_datetime: Scopes results to requests that happened before datetime + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -177,6 +182,7 @@ async def list_async( base_url = server_url request = models.VaultConsumerRequestCountsAllRequest( + app_id=app_id, consumer_id=consumer_id, start_datetime=start_datetime, end_datetime=end_datetime, diff --git a/src/apideck_unify/consumers.py b/src/apideck_unify/consumers.py index afcc8d9e..1d21543f 100644 --- a/src/apideck_unify/consumers.py +++ b/src/apideck_unify/consumers.py @@ -14,6 +14,7 @@ def create( self, *, consumer_id: str, + app_id: Optional[str] = None, metadata: Optional[ Union[models.ConsumerMetadata, models.ConsumerMetadataTypedDict] ] = None, @@ -27,6 +28,7 @@ def create( Create a consumer :param consumer_id: Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. + :param app_id: The ID of your Unify application :param metadata: The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -41,10 +43,13 @@ def create( if server_url is not None: base_url = server_url - request = models.ConsumerInput( - consumer_id=consumer_id, - metadata=utils.get_pydantic_model( - metadata, Optional[models.ConsumerMetadata] + request = models.VaultConsumersAddRequest( + app_id=app_id, + consumer=models.ConsumerInput( + consumer_id=consumer_id, + metadata=utils.get_pydantic_model( + metadata, Optional[models.ConsumerMetadata] + ), ), ) @@ -65,7 +70,7 @@ def create( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.ConsumerInput + request.consumer, False, False, "json", models.ConsumerInput ), timeout_ms=timeout_ms, ) @@ -151,6 +156,7 @@ async def create_async( self, *, consumer_id: str, + app_id: Optional[str] = None, metadata: Optional[ Union[models.ConsumerMetadata, models.ConsumerMetadataTypedDict] ] = None, @@ -164,6 +170,7 @@ async def create_async( Create a consumer :param consumer_id: Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. + :param app_id: The ID of your Unify application :param metadata: The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -178,10 +185,13 @@ async def create_async( if server_url is not None: base_url = server_url - request = models.ConsumerInput( - consumer_id=consumer_id, - metadata=utils.get_pydantic_model( - metadata, Optional[models.ConsumerMetadata] + request = models.VaultConsumersAddRequest( + app_id=app_id, + consumer=models.ConsumerInput( + consumer_id=consumer_id, + metadata=utils.get_pydantic_model( + metadata, Optional[models.ConsumerMetadata] + ), ), ) @@ -202,7 +212,7 @@ async def create_async( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.ConsumerInput + request.consumer, False, False, "json", models.ConsumerInput ), timeout_ms=timeout_ms, ) @@ -287,6 +297,7 @@ async def create_async( def list( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -299,6 +310,7 @@ def list( This endpoint includes all application consumers, along with an aggregated count of requests made. + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param retries: Override the default retry configuration for this method @@ -315,6 +327,7 @@ def list( base_url = server_url request = models.VaultConsumersAllRequest( + app_id=app_id, cursor=cursor, limit=limit, ) @@ -372,6 +385,7 @@ def next_func() -> Optional[models.VaultConsumersAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, retries=retries, @@ -434,6 +448,7 @@ def next_func() -> Optional[models.VaultConsumersAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -446,6 +461,7 @@ async def list_async( This endpoint includes all application consumers, along with an aggregated count of requests made. + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param retries: Override the default retry configuration for this method @@ -462,6 +478,7 @@ async def list_async( base_url = server_url request = models.VaultConsumersAllRequest( + app_id=app_id, cursor=cursor, limit=limit, ) @@ -519,6 +536,7 @@ def next_func() -> Optional[models.VaultConsumersAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, retries=retries, @@ -582,6 +600,7 @@ def get( self, *, consumer_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -593,6 +612,7 @@ def get( :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -607,6 +627,7 @@ def get( base_url = server_url request = models.VaultConsumersOneRequest( + app_id=app_id, consumer_id=consumer_id, ) @@ -710,6 +731,7 @@ async def get_async( self, *, consumer_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -721,6 +743,7 @@ async def get_async( :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -735,6 +758,7 @@ async def get_async( base_url = server_url request = models.VaultConsumersOneRequest( + app_id=app_id, consumer_id=consumer_id, ) @@ -838,6 +862,7 @@ def update( self, *, consumer_id: str, + app_id: Optional[str] = None, metadata: Optional[ Union[models.ConsumerMetadata, models.ConsumerMetadataTypedDict] ] = None, @@ -851,6 +876,7 @@ def update( Update consumer metadata such as name and email. :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param metadata: The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -866,6 +892,7 @@ def update( base_url = server_url request = models.VaultConsumersUpdateRequest( + app_id=app_id, consumer_id=consumer_id, update_consumer_request=models.UpdateConsumerRequest( metadata=utils.get_pydantic_model( @@ -981,6 +1008,7 @@ async def update_async( self, *, consumer_id: str, + app_id: Optional[str] = None, metadata: Optional[ Union[models.ConsumerMetadata, models.ConsumerMetadataTypedDict] ] = None, @@ -994,6 +1022,7 @@ async def update_async( Update consumer metadata such as name and email. :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param metadata: The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -1009,6 +1038,7 @@ async def update_async( base_url = server_url request = models.VaultConsumersUpdateRequest( + app_id=app_id, consumer_id=consumer_id, update_consumer_request=models.UpdateConsumerRequest( metadata=utils.get_pydantic_model( @@ -1124,6 +1154,7 @@ def delete( self, *, consumer_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1134,6 +1165,7 @@ def delete( Delete consumer and all their connections, including credentials. :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1148,6 +1180,7 @@ def delete( base_url = server_url request = models.VaultConsumersDeleteRequest( + app_id=app_id, consumer_id=consumer_id, ) @@ -1251,6 +1284,7 @@ async def delete_async( self, *, consumer_id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1261,6 +1295,7 @@ async def delete_async( Delete consumer and all their connections, including credentials. :param consumer_id: ID of the consumer to return + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1275,6 +1310,7 @@ async def delete_async( base_url = server_url request = models.VaultConsumersDeleteRequest( + app_id=app_id, consumer_id=consumer_id, ) diff --git a/src/apideck_unify/contacts.py b/src/apideck_unify/contacts.py index c251ddde..aa7fee59 100644 --- a/src/apideck_unify/contacts.py +++ b/src/apideck_unify/contacts.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( List contacts :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -55,6 +59,8 @@ def list( request = models.CrmContactsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -119,6 +125,8 @@ def next_func() -> Optional[models.CrmContactsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -187,6 +195,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -206,6 +216,8 @@ async def list_async( List contacts :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -228,6 +240,8 @@ async def list_async( request = models.CrmContactsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -292,6 +306,8 @@ def next_func() -> Optional[models.CrmContactsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -361,6 +377,8 @@ def create( *, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.ContactType] = UNSET, @@ -418,6 +436,8 @@ def create( :param name: Full name of the contact. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: The owner of the contact. :param type: The type of the contact. @@ -467,6 +487,8 @@ def create( request = models.CrmContactsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, contact=models.ContactInput( name=name, @@ -623,6 +645,8 @@ async def create_async( *, name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, type_: OptionalNullable[models.ContactType] = UNSET, @@ -680,6 +704,8 @@ async def create_async( :param name: Full name of the contact. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: The owner of the contact. :param type: The type of the contact. @@ -729,6 +755,8 @@ async def create_async( request = models.CrmContactsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, contact=models.ContactInput( name=name, @@ -884,6 +912,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -900,6 +930,8 @@ def get( Get contact :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -919,6 +951,8 @@ def get( request = models.CrmContactsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1026,6 +1060,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1042,6 +1078,8 @@ async def get_async( Get contact :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1061,6 +1099,8 @@ async def get_async( request = models.CrmContactsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1169,6 +1209,8 @@ def update( *, id: str, name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, owner_id: OptionalNullable[str] = UNSET, @@ -1227,6 +1269,8 @@ def update( :param id: ID of the record you are acting upon. :param name: Full name of the contact. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param owner_id: The owner of the contact. @@ -1277,6 +1321,8 @@ def update( request = models.CrmContactsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, contact=models.ContactInput( @@ -1434,6 +1480,8 @@ async def update_async( *, id: str, name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, owner_id: OptionalNullable[str] = UNSET, @@ -1492,6 +1540,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param name: Full name of the contact. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param owner_id: The owner of the contact. @@ -1542,6 +1592,8 @@ async def update_async( request = models.CrmContactsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, contact=models.ContactInput( @@ -1698,6 +1750,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1710,6 +1764,8 @@ def delete( Delete contact :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1727,6 +1783,8 @@ def delete( request = models.CrmContactsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1832,6 +1890,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1844,6 +1904,8 @@ async def delete_async( Delete contact :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1861,6 +1923,8 @@ async def delete_async( request = models.CrmContactsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/createcallback.py b/src/apideck_unify/createcallback.py index da605039..129f4eec 100644 --- a/src/apideck_unify/createcallback.py +++ b/src/apideck_unify/createcallback.py @@ -14,6 +14,8 @@ def state( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, redirect_uri: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -27,6 +29,8 @@ def state( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param redirect_uri: The redirect URI to be used after the connection is created. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -42,6 +46,8 @@ def state( base_url = server_url request = models.VaultCreateCallbackStateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, create_callback_state=models.CreateCallbackState( @@ -158,6 +164,8 @@ async def state_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, redirect_uri: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -171,6 +179,8 @@ async def state_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param redirect_uri: The redirect URI to be used after the connection is created. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -186,6 +196,8 @@ async def state_async( base_url = server_url request = models.VaultCreateCallbackStateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, create_callback_state=models.CreateCallbackState( diff --git a/src/apideck_unify/creditnotes.py b/src/apideck_unify/creditnotes.py index b026b535..63f0afb3 100644 --- a/src/apideck_unify/creditnotes.py +++ b/src/apideck_unify/creditnotes.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( List Credit Notes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.AccountingCreditNotesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> Optional[models.AccountingCreditNotesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -192,6 +200,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -213,6 +223,8 @@ async def list_async( List Credit Notes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -235,6 +247,8 @@ async def list_async( request = models.AccountingCreditNotesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> Optional[models.AccountingCreditNotesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -370,6 +386,8 @@ def create( *, total_amount: float, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ @@ -436,6 +454,8 @@ def create( :param total_amount: Amount of transaction :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Credit note number. :param customer: The customer this entity is linked to. @@ -479,6 +499,8 @@ def create( request = models.AccountingCreditNotesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, credit_note=models.CreditNoteInput( number=number, @@ -636,6 +658,8 @@ async def create_async( *, total_amount: float, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, number: OptionalNullable[str] = UNSET, customer: OptionalNullable[ @@ -702,6 +726,8 @@ async def create_async( :param total_amount: Amount of transaction :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Credit note number. :param customer: The customer this entity is linked to. @@ -745,6 +771,8 @@ async def create_async( request = models.AccountingCreditNotesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, credit_note=models.CreditNoteInput( number=number, @@ -901,6 +929,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -914,6 +944,8 @@ def get( Get Credit Note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -932,6 +964,8 @@ def get( request = models.AccountingCreditNotesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1038,6 +1072,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1051,6 +1087,8 @@ async def get_async( Get Credit Note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1069,6 +1107,8 @@ async def get_async( request = models.AccountingCreditNotesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1176,6 +1216,8 @@ def update( *, id: str, total_amount: float, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, number: OptionalNullable[str] = UNSET, @@ -1243,6 +1285,8 @@ def update( :param id: ID of the record you are acting upon. :param total_amount: Amount of transaction + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param number: Credit note number. @@ -1287,6 +1331,8 @@ def update( request = models.AccountingCreditNotesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, credit_note=models.CreditNoteInput( @@ -1445,6 +1491,8 @@ async def update_async( *, id: str, total_amount: float, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, number: OptionalNullable[str] = UNSET, @@ -1512,6 +1560,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param total_amount: Amount of transaction + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param number: Credit note number. @@ -1556,6 +1606,8 @@ async def update_async( request = models.AccountingCreditNotesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, credit_note=models.CreditNoteInput( @@ -1713,6 +1765,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1725,6 +1779,8 @@ def delete( Delete Credit Note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1742,6 +1798,8 @@ def delete( request = models.AccountingCreditNotesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1847,6 +1905,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1859,6 +1919,8 @@ async def delete_async( Delete Credit Note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1876,6 +1938,8 @@ async def delete_async( request = models.AccountingCreditNotesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/customers.py b/src/apideck_unify/customers.py index 48fd7d1b..bfdf23a0 100644 --- a/src/apideck_unify/customers.py +++ b/src/apideck_unify/customers.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -35,6 +37,8 @@ def list( List Customers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -57,6 +61,8 @@ def list( request = models.AccountingCustomersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -121,6 +127,8 @@ def next_func() -> Optional[models.AccountingCustomersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -189,6 +197,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -210,6 +220,8 @@ async def list_async( List Customers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -232,6 +244,8 @@ async def list_async( request = models.AccountingCustomersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -296,6 +310,8 @@ def next_func() -> Optional[models.AccountingCustomersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -364,6 +380,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: OptionalNullable[str] = UNSET, display_name: OptionalNullable[str] = UNSET, @@ -424,6 +442,8 @@ def create( Create Customer :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: Display ID :param display_name: Display name @@ -468,6 +488,8 @@ def create( request = models.AccountingCustomersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, customer=models.CustomerInput( display_id=display_id, @@ -623,6 +645,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: OptionalNullable[str] = UNSET, display_name: OptionalNullable[str] = UNSET, @@ -683,6 +707,8 @@ async def create_async( Create Customer :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: Display ID :param display_name: Display name @@ -727,6 +753,8 @@ async def create_async( request = models.AccountingCustomersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, customer=models.CustomerInput( display_id=display_id, @@ -882,6 +910,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -895,6 +925,8 @@ def get( Get Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -913,6 +945,8 @@ def get( request = models.AccountingCustomersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1019,6 +1053,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1032,6 +1068,8 @@ async def get_async( Get Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1050,6 +1088,8 @@ async def get_async( request = models.AccountingCustomersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1156,6 +1196,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: OptionalNullable[str] = UNSET, @@ -1217,6 +1259,8 @@ def update( Update Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: Display ID @@ -1262,6 +1306,8 @@ def update( request = models.AccountingCustomersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, customer=models.CustomerInput( @@ -1418,6 +1464,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: OptionalNullable[str] = UNSET, @@ -1479,6 +1527,8 @@ async def update_async( Update Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: Display ID @@ -1524,6 +1574,8 @@ async def update_async( request = models.AccountingCustomersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, customer=models.CustomerInput( @@ -1680,6 +1732,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1692,6 +1746,8 @@ def delete( Delete Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1709,6 +1765,8 @@ def delete( request = models.AccountingCustomersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1814,6 +1872,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1826,6 +1886,8 @@ async def delete_async( Delete Customer :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1843,6 +1905,8 @@ async def delete_async( request = models.AccountingCustomersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/customfields.py b/src/apideck_unify/customfields.py index c86fe7a1..b5c6eda8 100644 --- a/src/apideck_unify/customfields.py +++ b/src/apideck_unify/customfields.py @@ -15,6 +15,8 @@ def list( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, resource_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -29,6 +31,8 @@ def list( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param resource_id: This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -44,6 +48,8 @@ def list( base_url = server_url request = models.VaultCustomFieldsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, @@ -153,6 +159,8 @@ async def list_async( unified_api: str, service_id: str, resource: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, resource_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -167,6 +175,8 @@ async def list_async( :param unified_api: Unified API :param service_id: Service ID of the resource to return :param resource: Name of the resource (plural) + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param resource_id: This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -182,6 +192,8 @@ async def list_async( base_url = server_url request = models.VaultCustomFieldsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, resource=resource, diff --git a/src/apideck_unify/custommappings_sdk.py b/src/apideck_unify/custommappings_sdk.py index 28ebb9e2..5a78d2ef 100644 --- a/src/apideck_unify/custommappings_sdk.py +++ b/src/apideck_unify/custommappings_sdk.py @@ -14,6 +14,8 @@ def list( *, unified_api: str, service_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -25,6 +27,8 @@ def list( :param unified_api: Unified API :param service_id: Service ID of the resource to return + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -39,6 +43,8 @@ def list( base_url = server_url request = models.VaultCustomMappingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, ) @@ -145,6 +151,8 @@ async def list_async( *, unified_api: str, service_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -156,6 +164,8 @@ async def list_async( :param unified_api: Unified API :param service_id: Service ID of the resource to return + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -170,6 +180,8 @@ async def list_async( base_url = server_url request = models.VaultCustomMappingsAllRequest( + consumer_id=consumer_id, + app_id=app_id, unified_api=unified_api, service_id=service_id, ) diff --git a/src/apideck_unify/departments.py b/src/apideck_unify/departments.py index 3bfc6350..41f8f66f 100644 --- a/src/apideck_unify/departments.py +++ b/src/apideck_unify/departments.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Departments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -54,6 +58,8 @@ def list( request = models.AccountingDepartmentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -118,6 +124,8 @@ def next_func() -> Optional[models.AccountingDepartmentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -184,6 +192,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -204,6 +214,8 @@ async def list_async( List Departments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -224,6 +236,8 @@ async def list_async( request = models.AccountingDepartmentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -288,6 +302,8 @@ def next_func() -> Optional[models.AccountingDepartmentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -354,6 +370,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: OptionalNullable[str] = UNSET, @@ -378,6 +396,8 @@ def create( Create Department :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the department. @@ -400,6 +420,8 @@ def create( request = models.AccountingDepartmentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, accounting_department=models.AccountingDepartmentInput( parent_id=parent_id, @@ -523,6 +545,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: OptionalNullable[str] = UNSET, @@ -547,6 +571,8 @@ async def create_async( Create Department :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the department. @@ -569,6 +595,8 @@ async def create_async( request = models.AccountingDepartmentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, accounting_department=models.AccountingDepartmentInput( parent_id=parent_id, @@ -692,6 +720,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -705,6 +735,8 @@ def get( Get Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -723,6 +755,8 @@ def get( request = models.AccountingDepartmentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -829,6 +863,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -842,6 +878,8 @@ async def get_async( Get Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -860,6 +898,8 @@ async def get_async( request = models.AccountingDepartmentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -966,6 +1006,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -991,6 +1033,8 @@ def update( Update Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1014,6 +1058,8 @@ def update( request = models.AccountingDepartmentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, accounting_department=models.AccountingDepartmentInput( @@ -1138,6 +1184,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1163,6 +1211,8 @@ async def update_async( Update Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1186,6 +1236,8 @@ async def update_async( request = models.AccountingDepartmentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, accounting_department=models.AccountingDepartmentInput( @@ -1310,6 +1362,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1322,6 +1376,8 @@ def delete( Delete Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1339,6 +1395,8 @@ def delete( request = models.AccountingDepartmentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1444,6 +1502,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1456,6 +1516,8 @@ async def delete_async( Delete Department :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1473,6 +1535,8 @@ async def delete_async( request = models.AccountingDepartmentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/drivegroups.py b/src/apideck_unify/drivegroups.py index 2ff9c722..2484b855 100644 --- a/src/apideck_unify/drivegroups.py +++ b/src/apideck_unify/drivegroups.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -32,6 +34,8 @@ def list( List DriveGroups :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -53,6 +57,8 @@ def list( request = models.FileStorageDriveGroupsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -118,6 +124,8 @@ def next_func() -> Optional[models.FileStorageDriveGroupsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -185,6 +193,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -203,6 +213,8 @@ async def list_async( List DriveGroups :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -224,6 +236,8 @@ async def list_async( request = models.FileStorageDriveGroupsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -289,6 +303,8 @@ def next_func() -> Optional[models.FileStorageDriveGroupsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -357,6 +373,8 @@ def create( *, name: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_name: OptionalNullable[str] = UNSET, description: OptionalNullable[str] = UNSET, @@ -374,6 +392,8 @@ def create( :param name: The name of the drive group :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_name: The display name of the drive group :param description: A description of the object. @@ -393,6 +413,8 @@ def create( request = models.FileStorageDriveGroupsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, drive_group=models.DriveGroupInput( name=name, @@ -509,6 +531,8 @@ async def create_async( *, name: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_name: OptionalNullable[str] = UNSET, description: OptionalNullable[str] = UNSET, @@ -526,6 +550,8 @@ async def create_async( :param name: The name of the drive group :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_name: The display name of the drive group :param description: A description of the object. @@ -545,6 +571,8 @@ async def create_async( request = models.FileStorageDriveGroupsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, drive_group=models.DriveGroupInput( name=name, @@ -660,6 +688,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -673,6 +703,8 @@ def get( Get DriveGroup :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -691,6 +723,8 @@ def get( request = models.FileStorageDriveGroupsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -797,6 +831,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -810,6 +846,8 @@ async def get_async( Get DriveGroup :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -828,6 +866,8 @@ async def get_async( request = models.FileStorageDriveGroupsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -935,6 +975,8 @@ def update( *, id: str, name: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_name: OptionalNullable[str] = UNSET, @@ -953,6 +995,8 @@ def update( :param id: ID of the record you are acting upon. :param name: The name of the drive group + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_name: The display name of the drive group @@ -973,6 +1017,8 @@ def update( request = models.FileStorageDriveGroupsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, drive_group=models.DriveGroupInput( @@ -1090,6 +1136,8 @@ async def update_async( *, id: str, name: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_name: OptionalNullable[str] = UNSET, @@ -1108,6 +1156,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param name: The name of the drive group + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_name: The display name of the drive group @@ -1128,6 +1178,8 @@ async def update_async( request = models.FileStorageDriveGroupsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, drive_group=models.DriveGroupInput( @@ -1244,6 +1296,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1256,6 +1310,8 @@ def delete( Delete DriveGroup :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1273,6 +1329,8 @@ def delete( request = models.FileStorageDriveGroupsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1378,6 +1436,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1390,6 +1450,8 @@ async def delete_async( Delete DriveGroup :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1407,6 +1469,8 @@ async def delete_async( request = models.FileStorageDriveGroupsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/drives.py b/src/apideck_unify/drives.py index 931ce217..1ac4ed5d 100644 --- a/src/apideck_unify/drives.py +++ b/src/apideck_unify/drives.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -31,6 +33,8 @@ def list( List Drives :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -51,6 +55,8 @@ def list( request = models.FileStorageDrivesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -113,6 +119,8 @@ def next_func() -> Optional[models.FileStorageDrivesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -179,6 +187,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -196,6 +206,8 @@ async def list_async( List Drives :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -216,6 +228,8 @@ async def list_async( request = models.FileStorageDrivesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -278,6 +292,8 @@ def next_func() -> Optional[models.FileStorageDrivesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -345,6 +361,8 @@ def create( *, name: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, pass_through: Optional[ @@ -361,6 +379,8 @@ def create( :param name: The name of the drive :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param description: A description of the object. :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -379,6 +399,8 @@ def create( request = models.FileStorageDrivesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, drive=models.DriveInput( name=name, @@ -494,6 +516,8 @@ async def create_async( *, name: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, pass_through: Optional[ @@ -510,6 +534,8 @@ async def create_async( :param name: The name of the drive :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param description: A description of the object. :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -528,6 +554,8 @@ async def create_async( request = models.FileStorageDrivesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, drive=models.DriveInput( name=name, @@ -642,6 +670,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -655,6 +685,8 @@ def get( Get Drive :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -673,6 +705,8 @@ def get( request = models.FileStorageDrivesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -779,6 +813,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -792,6 +828,8 @@ async def get_async( Get Drive :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -810,6 +848,8 @@ async def get_async( request = models.FileStorageDrivesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -917,6 +957,8 @@ def update( *, id: str, name: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, description: OptionalNullable[str] = UNSET, @@ -934,6 +976,8 @@ def update( :param id: ID of the record you are acting upon. :param name: The name of the drive + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param description: A description of the object. @@ -953,6 +997,8 @@ def update( request = models.FileStorageDrivesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, drive=models.DriveInput( @@ -1069,6 +1115,8 @@ async def update_async( *, id: str, name: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, description: OptionalNullable[str] = UNSET, @@ -1086,6 +1134,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param name: The name of the drive + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param description: A description of the object. @@ -1105,6 +1155,8 @@ async def update_async( request = models.FileStorageDrivesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, drive=models.DriveInput( @@ -1220,6 +1272,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1232,6 +1286,8 @@ def delete( Delete Drive :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1249,6 +1305,8 @@ def delete( request = models.FileStorageDrivesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1354,6 +1412,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1366,6 +1426,8 @@ async def delete_async( Delete Drive :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1383,6 +1445,8 @@ async def delete_async( request = models.FileStorageDrivesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/employeepayrolls.py b/src/apideck_unify/employeepayrolls.py index d27592ff..84624dfa 100644 --- a/src/apideck_unify/employeepayrolls.py +++ b/src/apideck_unify/employeepayrolls.py @@ -14,6 +14,8 @@ def list( *, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.PayrollsFilter, models.PayrollsFilterTypedDict] @@ -31,6 +33,8 @@ def list( :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -51,6 +55,8 @@ def list( request = models.HrisEmployeePayrollsAllRequest( employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model(filter_, Optional[models.PayrollsFilter]), pass_through=pass_through, @@ -159,6 +165,8 @@ async def list_async( *, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.PayrollsFilter, models.PayrollsFilterTypedDict] @@ -176,6 +184,8 @@ async def list_async( :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -196,6 +206,8 @@ async def list_async( request = models.HrisEmployeePayrollsAllRequest( employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model(filter_, Optional[models.PayrollsFilter]), pass_through=pass_through, @@ -305,6 +317,8 @@ def get( payroll_id: str, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -319,6 +333,8 @@ def get( :param payroll_id: ID of the payroll you are acting upon. :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -338,6 +354,8 @@ def get( payroll_id=payroll_id, employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -445,6 +463,8 @@ async def get_async( payroll_id: str, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -459,6 +479,8 @@ async def get_async( :param payroll_id: ID of the payroll you are acting upon. :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -478,6 +500,8 @@ async def get_async( payroll_id=payroll_id, employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) diff --git a/src/apideck_unify/employees.py b/src/apideck_unify/employees.py index e8161ec2..0f6b51de 100644 --- a/src/apideck_unify/employees.py +++ b/src/apideck_unify/employees.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.HrisEmployeesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -122,6 +128,8 @@ def next_func() -> Optional[models.HrisEmployeesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -190,6 +198,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -211,6 +221,8 @@ async def list_async( Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -233,6 +245,8 @@ async def list_async( request = models.HrisEmployeesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -297,6 +311,8 @@ def next_func() -> Optional[models.HrisEmployeesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -365,6 +381,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, id: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, @@ -462,6 +480,8 @@ def create( Create Employee :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param id: A unique identifier for an object. :param first_name: The first name of the person. @@ -539,6 +559,8 @@ def create( request = models.HrisEmployeesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, employee=models.EmployeeInput( id=id, @@ -730,6 +752,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, id: OptionalNullable[str] = UNSET, first_name: OptionalNullable[str] = UNSET, @@ -827,6 +851,8 @@ async def create_async( Create Employee :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param id: A unique identifier for an object. :param first_name: The first name of the person. @@ -904,6 +930,8 @@ async def create_async( request = models.HrisEmployeesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, employee=models.EmployeeInput( id=id, @@ -1095,6 +1123,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1112,6 +1142,8 @@ def get( Get Employee :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1132,6 +1164,8 @@ def get( request = models.HrisEmployeesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1242,6 +1276,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1259,6 +1295,8 @@ async def get_async( Get Employee :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1279,6 +1317,8 @@ async def get_async( request = models.HrisEmployeesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1389,6 +1429,8 @@ def update( self, *, id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, id: OptionalNullable[str] = UNSET, @@ -1487,6 +1529,8 @@ def update( Update Employee :param id_param: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param id: A unique identifier for an object. @@ -1565,6 +1609,8 @@ def update( request = models.HrisEmployeesUpdateRequest( id_param=id_param, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee=models.EmployeeInput( @@ -1757,6 +1803,8 @@ async def update_async( self, *, id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, id: OptionalNullable[str] = UNSET, @@ -1855,6 +1903,8 @@ async def update_async( Update Employee :param id_param: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param id: A unique identifier for an object. @@ -1933,6 +1983,8 @@ async def update_async( request = models.HrisEmployeesUpdateRequest( id_param=id_param, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee=models.EmployeeInput( @@ -2125,6 +2177,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -2137,6 +2191,8 @@ def delete( Delete Employee :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -2154,6 +2210,8 @@ def delete( request = models.HrisEmployeesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -2259,6 +2317,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -2271,6 +2331,8 @@ async def delete_async( Delete Employee :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -2288,6 +2350,8 @@ async def delete_async( request = models.HrisEmployeesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/employeeschedules_sdk.py b/src/apideck_unify/employeeschedules_sdk.py index bf930bb7..29fc0b8e 100644 --- a/src/apideck_unify/employeeschedules_sdk.py +++ b/src/apideck_unify/employeeschedules_sdk.py @@ -14,6 +14,8 @@ def list( *, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through: Optional[Dict[str, Any]] = None, fields: OptionalNullable[str] = UNSET, @@ -28,6 +30,8 @@ def list( :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -47,6 +51,8 @@ def list( request = models.HrisEmployeeSchedulesAllRequest( employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through=pass_through, fields=fields, @@ -154,6 +160,8 @@ async def list_async( *, employee_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through: Optional[Dict[str, Any]] = None, fields: OptionalNullable[str] = UNSET, @@ -168,6 +176,8 @@ async def list_async( :param employee_id: ID of the employee you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -187,6 +197,8 @@ async def list_async( request = models.HrisEmployeeSchedulesAllRequest( employee_id=employee_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through=pass_through, fields=fields, diff --git a/src/apideck_unify/eventlogs.py b/src/apideck_unify/eventlogs.py index 810a8a1a..0f693815 100644 --- a/src/apideck_unify/eventlogs.py +++ b/src/apideck_unify/eventlogs.py @@ -13,6 +13,7 @@ class EventLogs(BaseSDK): def list( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[ @@ -27,6 +28,7 @@ def list( List event logs + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Filter results @@ -44,6 +46,7 @@ def list( base_url = server_url request = models.WebhookEventLogsAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model( @@ -104,6 +107,7 @@ def next_func() -> Optional[models.WebhookEventLogsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, @@ -167,6 +171,7 @@ def next_func() -> Optional[models.WebhookEventLogsAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, filter_: Optional[ @@ -181,6 +186,7 @@ async def list_async( List event logs + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param filter_: Filter results @@ -198,6 +204,7 @@ async def list_async( base_url = server_url request = models.WebhookEventLogsAllRequest( + app_id=app_id, cursor=cursor, limit=limit, filter_=utils.get_pydantic_model( @@ -258,6 +265,7 @@ def next_func() -> Optional[models.WebhookEventLogsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, filter_=filter_, diff --git a/src/apideck_unify/expenses.py b/src/apideck_unify/expenses.py index be65b796..33dbae55 100644 --- a/src/apideck_unify/expenses.py +++ b/src/apideck_unify/expenses.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -28,6 +30,8 @@ def list( List Expenses :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -46,6 +50,8 @@ def list( request = models.AccountingExpensesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -106,6 +112,8 @@ def next_func() -> Optional[models.AccountingExpensesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -170,6 +178,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -183,6 +193,8 @@ async def list_async( List Expenses :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -201,6 +213,8 @@ async def list_async( request = models.AccountingExpensesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -261,6 +275,8 @@ def next_func() -> Optional[models.AccountingExpensesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -331,6 +347,8 @@ def create( List[models.ExpenseLineItemInputTypedDict], ], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, number: OptionalNullable[str] = UNSET, customer_id: Optional[str] = None, @@ -366,6 +384,8 @@ def create( :param account_id: The unique identifier for the ledger account that this expense should be credited to. :param line_items: Expense line items linked to this expense. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. @@ -397,6 +417,8 @@ def create( request = models.AccountingExpensesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, expense=models.ExpenseInput( number=number, @@ -538,6 +560,8 @@ async def create_async( List[models.ExpenseLineItemInputTypedDict], ], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, number: OptionalNullable[str] = UNSET, customer_id: Optional[str] = None, @@ -573,6 +597,8 @@ async def create_async( :param account_id: The unique identifier for the ledger account that this expense should be credited to. :param line_items: Expense line items linked to this expense. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param number: Number. :param customer_id: The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. @@ -604,6 +630,8 @@ async def create_async( request = models.AccountingExpensesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, expense=models.ExpenseInput( number=number, @@ -739,6 +767,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -751,6 +781,8 @@ def get( Get Expense :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -768,6 +800,8 @@ def get( request = models.AccountingExpensesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -873,6 +907,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -885,6 +921,8 @@ async def get_async( Get Expense :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -902,6 +940,8 @@ async def get_async( request = models.AccountingExpensesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1013,6 +1053,8 @@ def update( List[models.ExpenseLineItemInput], List[models.ExpenseLineItemInputTypedDict], ], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, number: OptionalNullable[str] = UNSET, @@ -1049,6 +1091,8 @@ def update( :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param account_id: The unique identifier for the ledger account that this expense should be credited to. :param line_items: Expense line items linked to this expense. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param number: Number. @@ -1081,6 +1125,8 @@ def update( request = models.AccountingExpensesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, expense=models.ExpenseInput( @@ -1223,6 +1269,8 @@ async def update_async( List[models.ExpenseLineItemInput], List[models.ExpenseLineItemInputTypedDict], ], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, number: OptionalNullable[str] = UNSET, @@ -1259,6 +1307,8 @@ async def update_async( :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param account_id: The unique identifier for the ledger account that this expense should be credited to. :param line_items: Expense line items linked to this expense. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param number: Number. @@ -1291,6 +1341,8 @@ async def update_async( request = models.AccountingExpensesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, expense=models.ExpenseInput( @@ -1427,6 +1479,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1439,6 +1493,8 @@ def delete( Delete Expense :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1456,6 +1512,8 @@ def delete( request = models.AccountingExpensesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1561,6 +1619,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1573,6 +1633,8 @@ async def delete_async( Delete Expense :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1590,6 +1652,8 @@ async def delete_async( request = models.AccountingExpensesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/files.py b/src/apideck_unify/files.py index dbbc382c..c2756b84 100644 --- a/src/apideck_unify/files.py +++ b/src/apideck_unify/files.py @@ -25,6 +25,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -44,6 +46,8 @@ def list( List Files :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -66,6 +70,8 @@ def list( request = models.FileStorageFilesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -130,6 +136,8 @@ def next_func() -> Optional[models.FileStorageFilesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -198,6 +206,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -217,6 +227,8 @@ async def list_async( List Files :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -239,6 +251,8 @@ async def list_async( request = models.FileStorageFilesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -303,6 +317,8 @@ def next_func() -> Optional[models.FileStorageFilesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -371,6 +387,8 @@ def search( self, *, query: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through_param: Optional[Dict[str, Any]] = None, fields: OptionalNullable[str] = UNSET, @@ -393,6 +411,8 @@ def search( Search Files :param query: The query to search for. May match across multiple fields. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through_param: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -415,6 +435,8 @@ def search( base_url = server_url request = models.FileStorageFilesSearchRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through_param=pass_through_param, fields=fields, @@ -534,6 +556,8 @@ async def search_async( self, *, query: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, pass_through_param: Optional[Dict[str, Any]] = None, fields: OptionalNullable[str] = UNSET, @@ -556,6 +580,8 @@ async def search_async( Search Files :param query: The query to search for. May match across multiple fields. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param pass_through_param: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -578,6 +604,8 @@ async def search_async( base_url = server_url request = models.FileStorageFilesSearchRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, pass_through_param=pass_through_param, fields=fields, @@ -697,6 +725,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -710,6 +740,8 @@ def get( Get File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -728,6 +760,8 @@ def get( request = models.FileStorageFilesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -834,6 +868,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -847,6 +883,8 @@ async def get_async( Get File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -865,6 +903,8 @@ async def get_async( request = models.FileStorageFilesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -971,6 +1011,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -989,6 +1031,8 @@ def update( Rename or move File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of the file. @@ -1010,6 +1054,8 @@ def update( request = models.FileStorageFilesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, update_file_request=models.UpdateFileRequest( @@ -1130,6 +1176,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -1148,6 +1196,8 @@ async def update_async( Rename or move File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of the file. @@ -1169,6 +1219,8 @@ async def update_async( request = models.FileStorageFilesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, update_file_request=models.UpdateFileRequest( @@ -1289,6 +1341,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1301,6 +1355,8 @@ def delete( Delete File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1318,6 +1374,8 @@ def delete( request = models.FileStorageFilesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1423,6 +1481,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1435,6 +1495,8 @@ async def delete_async( Delete File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1452,6 +1514,8 @@ async def delete_async( request = models.FileStorageFilesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1557,6 +1621,8 @@ def download( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1570,6 +1636,8 @@ def download( Download File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1588,6 +1656,8 @@ def download( request = models.FileStorageFilesDownloadRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -1700,6 +1770,8 @@ async def download_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1713,6 +1785,8 @@ async def download_async( Download File :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1731,6 +1805,8 @@ async def download_async( request = models.FileStorageFilesDownloadRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -1844,6 +1920,8 @@ def export( *, id: str, file_format: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1858,6 +1936,8 @@ def export( :param id: ID of the record you are acting upon. :param file_format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1876,6 +1956,8 @@ def export( request = models.FileStorageFilesExportRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, file_format=file_format, @@ -1990,6 +2072,8 @@ async def export_async( *, id: str, file_format: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -2004,6 +2088,8 @@ async def export_async( :param id: ID of the record you are acting upon. :param file_format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -2022,6 +2108,8 @@ async def export_async( request = models.FileStorageFilesExportRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, file_format=file_format, diff --git a/src/apideck_unify/folders.py b/src/apideck_unify/folders.py index cf178250..68294528 100644 --- a/src/apideck_unify/folders.py +++ b/src/apideck_unify/folders.py @@ -15,6 +15,8 @@ def create( name: str, parent_folder_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, description: Optional[str] = None, @@ -34,6 +36,8 @@ def create( :param name: The name of the folder. :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param description: Optional description of the folder. @@ -54,6 +58,8 @@ def create( request = models.FileStorageFoldersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, create_folder_request=models.CreateFolderRequest( @@ -177,6 +183,8 @@ async def create_async( name: str, parent_folder_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, description: Optional[str] = None, @@ -196,6 +204,8 @@ async def create_async( :param name: The name of the folder. :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param description: Optional description of the folder. @@ -216,6 +226,8 @@ async def create_async( request = models.FileStorageFoldersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, create_folder_request=models.CreateFolderRequest( @@ -337,6 +349,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -350,6 +364,8 @@ def get( Get Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -368,6 +384,8 @@ def get( request = models.FileStorageFoldersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -474,6 +492,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -487,6 +507,8 @@ async def get_async( Get Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -505,6 +527,8 @@ async def get_async( request = models.FileStorageFoldersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -611,6 +635,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -629,6 +655,8 @@ def update( Rename or move Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of the folder. @@ -650,6 +678,8 @@ def update( request = models.FileStorageFoldersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, update_folder_request=models.UpdateFolderRequest( @@ -770,6 +800,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: Optional[str] = None, @@ -788,6 +820,8 @@ async def update_async( Rename or move Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: The name of the folder. @@ -809,6 +843,8 @@ async def update_async( request = models.FileStorageFoldersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, update_folder_request=models.UpdateFolderRequest( @@ -929,6 +965,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -941,6 +979,8 @@ def delete( Delete Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -958,6 +998,8 @@ def delete( request = models.FileStorageFoldersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1063,6 +1105,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1075,6 +1119,8 @@ async def delete_async( Delete Folder :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1092,6 +1138,8 @@ async def delete_async( request = models.FileStorageFoldersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1198,6 +1246,8 @@ def copy( *, id: str, parent_folder_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1216,6 +1266,8 @@ def copy( :param id: ID of the record you are acting upon. :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1236,6 +1288,8 @@ def copy( request = models.FileStorageFoldersCopyRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1357,6 +1411,8 @@ async def copy_async( *, id: str, parent_folder_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1375,6 +1431,8 @@ async def copy_async( :param id: ID of the record you are acting upon. :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1395,6 +1453,8 @@ async def copy_async( request = models.FileStorageFoldersCopyRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/invoiceitems.py b/src/apideck_unify/invoiceitems.py index d5263f23..b3a4d67e 100644 --- a/src/apideck_unify/invoiceitems.py +++ b/src/apideck_unify/invoiceitems.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( List Invoice Items :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -54,6 +58,8 @@ def list( request = models.AccountingInvoiceItemsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -119,6 +125,8 @@ def next_func() -> Optional[models.AccountingInvoiceItemsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -186,6 +194,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -204,6 +214,8 @@ async def list_async( List Invoice Items :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -225,6 +237,8 @@ async def list_async( request = models.AccountingInvoiceItemsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -290,6 +304,8 @@ def next_func() -> Optional[models.AccountingInvoiceItemsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -357,6 +373,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: OptionalNullable[str] = UNSET, description: OptionalNullable[str] = UNSET, @@ -425,6 +443,8 @@ def create( Create Invoice Item :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: Item name :param description: A short description of the item @@ -462,6 +482,8 @@ def create( request = models.AccountingInvoiceItemsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, invoice_item=models.InvoiceItemInput( name=name, @@ -610,6 +632,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, name: OptionalNullable[str] = UNSET, description: OptionalNullable[str] = UNSET, @@ -678,6 +702,8 @@ async def create_async( Create Invoice Item :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param name: Item name :param description: A short description of the item @@ -715,6 +741,8 @@ async def create_async( request = models.AccountingInvoiceItemsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, invoice_item=models.InvoiceItemInput( name=name, @@ -863,6 +891,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -879,6 +909,8 @@ def get( Get Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -898,6 +930,8 @@ def get( request = models.AccountingInvoiceItemsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1007,6 +1041,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1023,6 +1059,8 @@ async def get_async( Get Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1042,6 +1080,8 @@ async def get_async( request = models.AccountingInvoiceItemsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1151,6 +1191,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: OptionalNullable[str] = UNSET, @@ -1220,6 +1262,8 @@ def update( Update Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: Item name @@ -1258,6 +1302,8 @@ def update( request = models.AccountingInvoiceItemsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, invoice_item=models.InvoiceItemInput( @@ -1407,6 +1453,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, name: OptionalNullable[str] = UNSET, @@ -1476,6 +1524,8 @@ async def update_async( Update Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param name: Item name @@ -1514,6 +1564,8 @@ async def update_async( request = models.AccountingInvoiceItemsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, invoice_item=models.InvoiceItemInput( @@ -1663,6 +1715,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1675,6 +1729,8 @@ def delete( Delete Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1692,6 +1748,8 @@ def delete( request = models.AccountingInvoiceItemsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1797,6 +1855,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1809,6 +1869,8 @@ async def delete_async( Delete Invoice Item :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1826,6 +1888,8 @@ async def delete_async( request = models.AccountingInvoiceItemsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/invoices.py b/src/apideck_unify/invoices.py index b00d1aa7..83f2719b 100644 --- a/src/apideck_unify/invoices.py +++ b/src/apideck_unify/invoices.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Invoices :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -56,6 +60,8 @@ def list( request = models.AccountingInvoicesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -120,6 +126,8 @@ def next_func() -> Optional[models.AccountingInvoicesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -207,6 +217,8 @@ async def list_async( List Invoices :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -229,6 +241,8 @@ async def list_async( request = models.AccountingInvoicesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -293,6 +307,8 @@ def next_func() -> Optional[models.AccountingInvoicesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -361,6 +377,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, @@ -443,6 +461,8 @@ def create( Create Invoice :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param type: Invoice type :param number: Invoice number. @@ -498,6 +518,8 @@ def create( request = models.AccountingInvoicesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, invoice=models.InvoiceInput( type=type_, @@ -668,6 +690,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, type_: OptionalNullable[models.InvoiceType] = UNSET, number: OptionalNullable[str] = UNSET, @@ -750,6 +774,8 @@ async def create_async( Create Invoice :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param type: Invoice type :param number: Invoice number. @@ -805,6 +831,8 @@ async def create_async( request = models.AccountingInvoicesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, invoice=models.InvoiceInput( type=type_, @@ -975,6 +1003,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -988,6 +1018,8 @@ def get( Get Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1006,6 +1038,8 @@ def get( request = models.AccountingInvoicesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1112,6 +1146,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1125,6 +1161,8 @@ async def get_async( Get Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1143,6 +1181,8 @@ async def get_async( request = models.AccountingInvoicesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1249,6 +1289,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, type_: OptionalNullable[models.InvoiceType] = UNSET, @@ -1332,6 +1374,8 @@ def update( Update Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param type: Invoice type @@ -1388,6 +1432,8 @@ def update( request = models.AccountingInvoicesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, invoice=models.InvoiceInput( @@ -1559,6 +1605,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, type_: OptionalNullable[models.InvoiceType] = UNSET, @@ -1642,6 +1690,8 @@ async def update_async( Update Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param type: Invoice type @@ -1698,6 +1748,8 @@ async def update_async( request = models.AccountingInvoicesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, invoice=models.InvoiceInput( @@ -1869,6 +1921,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1881,6 +1935,8 @@ def delete( Delete Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1898,6 +1954,8 @@ def delete( request = models.AccountingInvoicesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -2003,6 +2061,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -2015,6 +2075,8 @@ async def delete_async( Delete Invoice :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -2032,6 +2094,8 @@ async def delete_async( request = models.AccountingInvoicesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/jobs.py b/src/apideck_unify/jobs.py index 82a0a9ae..14ba6cb1 100644 --- a/src/apideck_unify/jobs.py +++ b/src/apideck_unify/jobs.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Jobs :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.AtsJobsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.AtsJobsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List Jobs :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.AtsJobsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.AtsJobsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -340,6 +356,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -353,6 +371,8 @@ def get( Get Job :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -371,6 +391,8 @@ def get( request = models.AtsJobsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -477,6 +499,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -490,6 +514,8 @@ async def get_async( Get Job :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -508,6 +534,8 @@ async def get_async( request = models.AtsJobsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/journalentries.py b/src/apideck_unify/journalentries.py index a65aed6b..e4bb9b9e 100644 --- a/src/apideck_unify/journalentries.py +++ b/src/apideck_unify/journalentries.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( List Journal Entries :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.AccountingJournalEntriesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> Optional[models.AccountingJournalEntriesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -192,6 +200,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -213,6 +223,8 @@ async def list_async( List Journal Entries :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -235,6 +247,8 @@ async def list_async( request = models.AccountingJournalEntriesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> Optional[models.AccountingJournalEntriesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -369,6 +385,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, title: OptionalNullable[str] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -410,6 +428,8 @@ def create( Create Journal Entry :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -442,6 +462,8 @@ def create( request = models.AccountingJournalEntriesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, journal_entry=models.JournalEntryInput( title=title, @@ -576,6 +598,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, title: OptionalNullable[str] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -617,6 +641,8 @@ async def create_async( Create Journal Entry :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param title: Journal entry title :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -649,6 +675,8 @@ async def create_async( request = models.AccountingJournalEntriesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, journal_entry=models.JournalEntryInput( title=title, @@ -783,6 +811,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -796,6 +826,8 @@ def get( Get Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -814,6 +846,8 @@ def get( request = models.AccountingJournalEntriesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -920,6 +954,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -933,6 +969,8 @@ async def get_async( Get Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -951,6 +989,8 @@ async def get_async( request = models.AccountingJournalEntriesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1057,6 +1097,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, title: OptionalNullable[str] = UNSET, @@ -1099,6 +1141,8 @@ def update( Update Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param title: Journal entry title @@ -1132,6 +1176,8 @@ def update( request = models.AccountingJournalEntriesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, journal_entry=models.JournalEntryInput( @@ -1267,6 +1313,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, title: OptionalNullable[str] = UNSET, @@ -1309,6 +1357,8 @@ async def update_async( Update Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param title: Journal entry title @@ -1342,6 +1392,8 @@ async def update_async( request = models.AccountingJournalEntriesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, journal_entry=models.JournalEntryInput( @@ -1477,6 +1529,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1489,6 +1543,8 @@ def delete( Delete Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1506,6 +1562,8 @@ def delete( request = models.AccountingJournalEntriesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1611,6 +1669,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1623,6 +1683,8 @@ async def delete_async( Delete Journal Entry :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1640,6 +1702,8 @@ async def delete_async( request = models.AccountingJournalEntriesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/leads.py b/src/apideck_unify/leads.py index c9f13c56..d7e7fd45 100644 --- a/src/apideck_unify/leads.py +++ b/src/apideck_unify/leads.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( List leads :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -55,6 +59,8 @@ def list( request = models.CrmLeadsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -119,6 +125,8 @@ def next_func() -> Optional[models.CrmLeadsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -187,6 +195,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -206,6 +216,8 @@ async def list_async( List leads :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -228,6 +240,8 @@ async def list_async( request = models.CrmLeadsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -292,6 +306,8 @@ def next_func() -> Optional[models.CrmLeadsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -362,6 +378,8 @@ def create( name: str, company_name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, owner_name: OptionalNullable[str] = UNSET, @@ -410,6 +428,8 @@ def create( :param name: Full name of the lead. :param company_name: The name of the company the lead is associated with. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: The owner of the lead. :param owner_name: The name of the owner of the lead. @@ -449,6 +469,8 @@ def create( request = models.CrmLeadsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, lead=models.LeadInput( name=name, @@ -597,6 +619,8 @@ async def create_async( name: str, company_name: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, owner_id: OptionalNullable[str] = UNSET, owner_name: OptionalNullable[str] = UNSET, @@ -645,6 +669,8 @@ async def create_async( :param name: Full name of the lead. :param company_name: The name of the company the lead is associated with. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param owner_id: The owner of the lead. :param owner_name: The name of the owner of the lead. @@ -684,6 +710,8 @@ async def create_async( request = models.CrmLeadsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, lead=models.LeadInput( name=name, @@ -830,6 +858,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -843,6 +873,8 @@ def get( Get lead :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -861,6 +893,8 @@ def get( request = models.CrmLeadsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -967,6 +1001,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -980,6 +1016,8 @@ async def get_async( Get lead :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -998,6 +1036,8 @@ async def get_async( request = models.CrmLeadsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1106,6 +1146,8 @@ def update( id: str, name: str, company_name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, owner_id: OptionalNullable[str] = UNSET, @@ -1155,6 +1197,8 @@ def update( :param id: ID of the record you are acting upon. :param name: Full name of the lead. :param company_name: The name of the company the lead is associated with. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param owner_id: The owner of the lead. @@ -1195,6 +1239,8 @@ def update( request = models.CrmLeadsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, lead=models.LeadInput( @@ -1344,6 +1390,8 @@ async def update_async( id: str, name: str, company_name: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, owner_id: OptionalNullable[str] = UNSET, @@ -1393,6 +1441,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param name: Full name of the lead. :param company_name: The name of the company the lead is associated with. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param owner_id: The owner of the lead. @@ -1433,6 +1483,8 @@ async def update_async( request = models.CrmLeadsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, lead=models.LeadInput( @@ -1580,6 +1632,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1592,6 +1646,8 @@ def delete( Delete lead :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1609,6 +1665,8 @@ def delete( request = models.CrmLeadsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1714,6 +1772,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1726,6 +1786,8 @@ async def delete_async( Delete lead :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1743,6 +1805,8 @@ async def delete_async( request = models.CrmLeadsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/ledgeraccounts.py b/src/apideck_unify/ledgeraccounts.py index dab52e93..0be47f3c 100644 --- a/src/apideck_unify/ledgeraccounts.py +++ b/src/apideck_unify/ledgeraccounts.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( List Ledger Accounts :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.AccountingLedgerAccountsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> Optional[models.AccountingLedgerAccountsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -192,6 +200,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -213,6 +223,8 @@ async def list_async( List Ledger Accounts :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -235,6 +247,8 @@ async def list_async( request = models.AccountingLedgerAccountsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> Optional[models.AccountingLedgerAccountsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -369,6 +385,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: Optional[str] = None, nominal_code: OptionalNullable[str] = UNSET, @@ -421,6 +439,8 @@ def create( Create Ledger Account :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: The human readable display ID used when displaying the account :param nominal_code: The nominal code of the ledger account. @@ -463,6 +483,8 @@ def create( request = models.AccountingLedgerAccountsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, ledger_account=models.LedgerAccountInput( display_id=display_id, @@ -610,6 +632,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: Optional[str] = None, nominal_code: OptionalNullable[str] = UNSET, @@ -662,6 +686,8 @@ async def create_async( Create Ledger Account :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: The human readable display ID used when displaying the account :param nominal_code: The nominal code of the ledger account. @@ -704,6 +730,8 @@ async def create_async( request = models.AccountingLedgerAccountsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, ledger_account=models.LedgerAccountInput( display_id=display_id, @@ -851,6 +879,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -864,6 +894,8 @@ def get( Get Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -882,6 +914,8 @@ def get( request = models.AccountingLedgerAccountsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -988,6 +1022,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1001,6 +1037,8 @@ async def get_async( Get Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1019,6 +1057,8 @@ async def get_async( request = models.AccountingLedgerAccountsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1125,6 +1165,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: Optional[str] = None, @@ -1178,6 +1220,8 @@ def update( Update Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: The human readable display ID used when displaying the account @@ -1221,6 +1265,8 @@ def update( request = models.AccountingLedgerAccountsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ledger_account=models.LedgerAccountInput( @@ -1369,6 +1415,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: Optional[str] = None, @@ -1422,6 +1470,8 @@ async def update_async( Update Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: The human readable display ID used when displaying the account @@ -1465,6 +1515,8 @@ async def update_async( request = models.AccountingLedgerAccountsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ledger_account=models.LedgerAccountInput( @@ -1613,6 +1665,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1625,6 +1679,8 @@ def delete( Delete Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1642,6 +1698,8 @@ def delete( request = models.AccountingLedgerAccountsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1747,6 +1805,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1759,6 +1819,8 @@ async def delete_async( Delete Ledger Account :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1776,6 +1838,8 @@ async def delete_async( request = models.AccountingLedgerAccountsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/locations.py b/src/apideck_unify/locations.py index c19f9760..ed76611b 100644 --- a/src/apideck_unify/locations.py +++ b/src/apideck_unify/locations.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Locations :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -54,6 +58,8 @@ def list( request = models.AccountingLocationsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -118,6 +124,8 @@ def next_func() -> Optional[models.AccountingLocationsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -184,6 +192,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -204,6 +214,8 @@ async def list_async( List Locations :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -224,6 +236,8 @@ async def list_async( request = models.AccountingLocationsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -288,6 +302,8 @@ def next_func() -> Optional[models.AccountingLocationsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -354,6 +370,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, company_name: OptionalNullable[str] = UNSET, @@ -382,6 +400,8 @@ def create( Create Location :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param company_name: The name of the company. @@ -406,6 +426,8 @@ def create( request = models.AccountingLocationsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, accounting_location=models.AccountingLocationInput( parent_id=parent_id, @@ -533,6 +555,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, company_name: OptionalNullable[str] = UNSET, @@ -561,6 +585,8 @@ async def create_async( Create Location :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param company_name: The name of the company. @@ -585,6 +611,8 @@ async def create_async( request = models.AccountingLocationsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, accounting_location=models.AccountingLocationInput( parent_id=parent_id, @@ -712,6 +740,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -725,6 +755,8 @@ def get( Get Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -743,6 +775,8 @@ def get( request = models.AccountingLocationsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -849,6 +883,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -862,6 +898,8 @@ async def get_async( Get Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -880,6 +918,8 @@ async def get_async( request = models.AccountingLocationsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -986,6 +1026,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1015,6 +1057,8 @@ def update( Update Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1040,6 +1084,8 @@ def update( request = models.AccountingLocationsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, accounting_location=models.AccountingLocationInput( @@ -1168,6 +1214,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1197,6 +1245,8 @@ async def update_async( Update Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1222,6 +1272,8 @@ async def update_async( request = models.AccountingLocationsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, accounting_location=models.AccountingLocationInput( @@ -1350,6 +1402,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1362,6 +1416,8 @@ def delete( Delete Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1379,6 +1435,8 @@ def delete( request = models.AccountingLocationsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1484,6 +1542,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1496,6 +1556,8 @@ async def delete_async( Delete Location :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1513,6 +1575,8 @@ async def delete_async( request = models.AccountingLocationsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/logs.py b/src/apideck_unify/logs.py index c64e0a0e..4e0eed76 100644 --- a/src/apideck_unify/logs.py +++ b/src/apideck_unify/logs.py @@ -13,6 +13,8 @@ class Logs(BaseSDK): def list( self, *, + app_id: Optional[str] = None, + consumer_id: Optional[str] = None, filter_: Optional[Union[models.LogsFilter, models.LogsFilterTypedDict]] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -26,6 +28,8 @@ def list( This endpoint includes all consumer request logs. + :param app_id: The ID of your Unify application + :param consumer_id: ID of the consumer which you want to get or push data from :param filter_: Filter results :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -43,6 +47,8 @@ def list( base_url = server_url request = models.VaultLogsAllRequest( + app_id=app_id, + consumer_id=consumer_id, filter_=utils.get_pydantic_model(filter_, Optional[models.LogsFilter]), cursor=cursor, limit=limit, @@ -102,6 +108,8 @@ def next_func() -> Optional[models.VaultLogsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, + consumer_id=consumer_id, filter_=filter_, cursor=next_cursor, limit=limit, @@ -165,6 +173,8 @@ def next_func() -> Optional[models.VaultLogsAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, + consumer_id: Optional[str] = None, filter_: Optional[Union[models.LogsFilter, models.LogsFilterTypedDict]] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -178,6 +188,8 @@ async def list_async( This endpoint includes all consumer request logs. + :param app_id: The ID of your Unify application + :param consumer_id: ID of the consumer which you want to get or push data from :param filter_: Filter results :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -195,6 +207,8 @@ async def list_async( base_url = server_url request = models.VaultLogsAllRequest( + app_id=app_id, + consumer_id=consumer_id, filter_=utils.get_pydantic_model(filter_, Optional[models.LogsFilter]), cursor=cursor, limit=limit, @@ -254,6 +268,8 @@ def next_func() -> Optional[models.VaultLogsAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, + consumer_id=consumer_id, filter_=filter_, cursor=next_cursor, limit=limit, diff --git a/src/apideck_unify/messages.py b/src/apideck_unify/messages.py index 9a69521d..66d5f192 100644 --- a/src/apideck_unify/messages.py +++ b/src/apideck_unify/messages.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Messages :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -48,6 +52,8 @@ def list( request = models.SmsMessagesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -109,6 +115,8 @@ def next_func() -> Optional[models.SmsMessagesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -174,6 +182,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -188,6 +198,8 @@ async def list_async( List Messages :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -207,6 +219,8 @@ async def list_async( request = models.SmsMessagesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -268,6 +282,8 @@ def next_func() -> Optional[models.SmsMessagesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -336,6 +352,8 @@ def create( to: str, body: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, subject: Optional[str] = None, type_: Optional[models.MessageType] = None, @@ -359,6 +377,8 @@ def create( :param to: The phone number that received the message. :param body: The message text. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param subject: :param type: Set to sms for SMS messages and mms for MMS messages. @@ -382,6 +402,8 @@ def create( request = models.SmsMessagesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, message=models.MessageInput( from_=from_, @@ -506,6 +528,8 @@ async def create_async( to: str, body: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, subject: Optional[str] = None, type_: Optional[models.MessageType] = None, @@ -529,6 +553,8 @@ async def create_async( :param to: The phone number that received the message. :param body: The message text. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param subject: :param type: Set to sms for SMS messages and mms for MMS messages. @@ -552,6 +578,8 @@ async def create_async( request = models.SmsMessagesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, message=models.MessageInput( from_=from_, @@ -673,6 +701,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -686,6 +716,8 @@ def get( Get Message :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -704,6 +736,8 @@ def get( request = models.SmsMessagesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -810,6 +844,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -823,6 +859,8 @@ async def get_async( Get Message :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -841,6 +879,8 @@ async def get_async( request = models.SmsMessagesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -950,6 +990,8 @@ def update( from_: str, to: str, body: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, subject: Optional[str] = None, @@ -974,6 +1016,8 @@ def update( :param from_: The phone number that initiated the message. :param to: The phone number that received the message. :param body: The message text. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param subject: @@ -998,6 +1042,8 @@ def update( request = models.SmsMessagesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, message=models.MessageInput( @@ -1123,6 +1169,8 @@ async def update_async( from_: str, to: str, body: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, subject: Optional[str] = None, @@ -1147,6 +1195,8 @@ async def update_async( :param from_: The phone number that initiated the message. :param to: The phone number that received the message. :param body: The message text. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param subject: @@ -1171,6 +1221,8 @@ async def update_async( request = models.SmsMessagesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, message=models.MessageInput( @@ -1293,6 +1345,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1305,6 +1359,8 @@ def delete( Delete Message :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1322,6 +1378,8 @@ def delete( request = models.SmsMessagesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1427,6 +1485,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1439,6 +1499,8 @@ async def delete_async( Delete Message :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1456,6 +1518,8 @@ async def delete_async( request = models.SmsMessagesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/models/__init__.py b/src/apideck_unify/models/__init__.py index 5f73d9ee..c19face3 100644 --- a/src/apideck_unify/models/__init__.py +++ b/src/apideck_unify/models/__init__.py @@ -3416,6 +3416,8 @@ from .vault_consumersaddop import ( VaultConsumersAddGlobals, VaultConsumersAddGlobalsTypedDict, + VaultConsumersAddRequest, + VaultConsumersAddRequestTypedDict, VaultConsumersAddResponse, VaultConsumersAddResponseTypedDict, ) @@ -3486,6 +3488,8 @@ from .vault_sessionscreateop import ( VaultSessionsCreateGlobals, VaultSessionsCreateGlobalsTypedDict, + VaultSessionsCreateRequest, + VaultSessionsCreateRequestTypedDict, VaultSessionsCreateResponse, VaultSessionsCreateResponseTypedDict, ) @@ -3511,6 +3515,8 @@ from .webhook_webhooksaddop import ( WebhookWebhooksAddGlobals, WebhookWebhooksAddGlobalsTypedDict, + WebhookWebhooksAddRequest, + WebhookWebhooksAddRequestTypedDict, WebhookWebhooksAddResponse, WebhookWebhooksAddResponseTypedDict, ) @@ -6364,6 +6370,8 @@ "VaultConsumerRequestCountsAllResponseTypedDict", "VaultConsumersAddGlobals", "VaultConsumersAddGlobalsTypedDict", + "VaultConsumersAddRequest", + "VaultConsumersAddRequestTypedDict", "VaultConsumersAddResponse", "VaultConsumersAddResponseTypedDict", "VaultConsumersAllGlobals", @@ -6416,6 +6424,8 @@ "VaultLogsAllResponseTypedDict", "VaultSessionsCreateGlobals", "VaultSessionsCreateGlobalsTypedDict", + "VaultSessionsCreateRequest", + "VaultSessionsCreateRequestTypedDict", "VaultSessionsCreateResponse", "VaultSessionsCreateResponseTypedDict", "VaultValidateConnectionStateGlobals", @@ -6454,6 +6464,8 @@ "WebhookTypedDict", "WebhookWebhooksAddGlobals", "WebhookWebhooksAddGlobalsTypedDict", + "WebhookWebhooksAddRequest", + "WebhookWebhooksAddRequestTypedDict", "WebhookWebhooksAddResponse", "WebhookWebhooksAddResponseTypedDict", "WebhookWebhooksAllGlobals", diff --git a/src/apideck_unify/models/accounting_ageddebtorsoneop.py b/src/apideck_unify/models/accounting_ageddebtorsoneop.py index 52d6ebcf..0f124812 100644 --- a/src/apideck_unify/models/accounting_ageddebtorsoneop.py +++ b/src/apideck_unify/models/accounting_ageddebtorsoneop.py @@ -51,6 +51,10 @@ class AccountingAgedDebtorsOneGlobals(BaseModel): class AccountingAgedDebtorsOneRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" filter_: NotRequired[AgedReportFilterTypedDict] @@ -68,6 +72,20 @@ class AccountingAgedDebtorsOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -96,7 +114,15 @@ class AccountingAgedDebtorsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "filter", "pass_through", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "filter", + "pass_through", + "fields", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_attachmentsallop.py b/src/apideck_unify/models/accounting_attachmentsallop.py index 616f4573..0b1a7c7f 100644 --- a/src/apideck_unify/models/accounting_attachmentsallop.py +++ b/src/apideck_unify/models/accounting_attachmentsallop.py @@ -60,6 +60,10 @@ class AccountingAttachmentsAllRequestTypedDict(TypedDict): r"""The reference id of the object to retrieve.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -88,6 +92,20 @@ class AccountingAttachmentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -115,7 +133,15 @@ class AccountingAttachmentsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_attachmentsdeleteop.py b/src/apideck_unify/models/accounting_attachmentsdeleteop.py index df131f5f..69ae3710 100644 --- a/src/apideck_unify/models/accounting_attachmentsdeleteop.py +++ b/src/apideck_unify/models/accounting_attachmentsdeleteop.py @@ -53,6 +53,10 @@ class AccountingAttachmentsDeleteRequestTypedDict(TypedDict): r"""The reference id of the object to retrieve.""" id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -76,6 +80,20 @@ class AccountingAttachmentsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_attachmentsdownloadop.py b/src/apideck_unify/models/accounting_attachmentsdownloadop.py index fd657357..d9d3ed24 100644 --- a/src/apideck_unify/models/accounting_attachmentsdownloadop.py +++ b/src/apideck_unify/models/accounting_attachmentsdownloadop.py @@ -57,6 +57,10 @@ class AccountingAttachmentsDownloadRequestTypedDict(TypedDict): r"""The reference id of the object to retrieve.""" id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -80,6 +84,20 @@ class AccountingAttachmentsDownloadRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -95,7 +113,7 @@ class AccountingAttachmentsDownloadRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_attachmentsoneop.py b/src/apideck_unify/models/accounting_attachmentsoneop.py index 18fbe70c..7569b359 100644 --- a/src/apideck_unify/models/accounting_attachmentsoneop.py +++ b/src/apideck_unify/models/accounting_attachmentsoneop.py @@ -57,6 +57,10 @@ class AccountingAttachmentsOneRequestTypedDict(TypedDict): r"""The reference id of the object to retrieve.""" id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -82,6 +86,20 @@ class AccountingAttachmentsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -103,7 +121,7 @@ class AccountingAttachmentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_balancesheetoneop.py b/src/apideck_unify/models/accounting_balancesheetoneop.py index d1d53338..b7ad0756 100644 --- a/src/apideck_unify/models/accounting_balancesheetoneop.py +++ b/src/apideck_unify/models/accounting_balancesheetoneop.py @@ -42,6 +42,10 @@ class AccountingBalanceSheetOneGlobals(BaseModel): class AccountingBalanceSheetOneRequestTypedDict(TypedDict): + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" pass_through: NotRequired[Dict[str, Any]] @@ -53,6 +57,20 @@ class AccountingBalanceSheetOneRequestTypedDict(TypedDict): class AccountingBalanceSheetOneRequest(BaseModel): + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billpaymentsaddop.py b/src/apideck_unify/models/accounting_billpaymentsaddop.py index 9a3a58da..8b0395a5 100644 --- a/src/apideck_unify/models/accounting_billpaymentsaddop.py +++ b/src/apideck_unify/models/accounting_billpaymentsaddop.py @@ -50,6 +50,10 @@ class AccountingBillPaymentsAddRequestTypedDict(TypedDict): bill_payment: BillPaymentInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingBillPaymentsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billpaymentsallop.py b/src/apideck_unify/models/accounting_billpaymentsallop.py index 7af43b4a..9c882e57 100644 --- a/src/apideck_unify/models/accounting_billpaymentsallop.py +++ b/src/apideck_unify/models/accounting_billpaymentsallop.py @@ -52,6 +52,10 @@ class AccountingBillPaymentsAllGlobals(BaseModel): class AccountingBillPaymentsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class AccountingBillPaymentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class AccountingBillPaymentsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_billpaymentsdeleteop.py b/src/apideck_unify/models/accounting_billpaymentsdeleteop.py index 6745cb9a..cb512bcd 100644 --- a/src/apideck_unify/models/accounting_billpaymentsdeleteop.py +++ b/src/apideck_unify/models/accounting_billpaymentsdeleteop.py @@ -48,6 +48,10 @@ class AccountingBillPaymentsDeleteGlobals(BaseModel): class AccountingBillPaymentsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingBillPaymentsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billpaymentsoneop.py b/src/apideck_unify/models/accounting_billpaymentsoneop.py index e8e88b2a..52395230 100644 --- a/src/apideck_unify/models/accounting_billpaymentsoneop.py +++ b/src/apideck_unify/models/accounting_billpaymentsoneop.py @@ -55,6 +55,10 @@ class AccountingBillPaymentsOneGlobals(BaseModel): class AccountingBillPaymentsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingBillPaymentsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingBillPaymentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_billpaymentsupdateop.py b/src/apideck_unify/models/accounting_billpaymentsupdateop.py index e81a84f3..dbc8cf7c 100644 --- a/src/apideck_unify/models/accounting_billpaymentsupdateop.py +++ b/src/apideck_unify/models/accounting_billpaymentsupdateop.py @@ -51,6 +51,10 @@ class AccountingBillPaymentsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" bill_payment: BillPaymentInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingBillPaymentsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billsaddop.py b/src/apideck_unify/models/accounting_billsaddop.py index 1c903ee8..3f13340c 100644 --- a/src/apideck_unify/models/accounting_billsaddop.py +++ b/src/apideck_unify/models/accounting_billsaddop.py @@ -47,6 +47,10 @@ class AccountingBillsAddRequestTypedDict(TypedDict): bill: BillInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -62,6 +66,20 @@ class AccountingBillsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billsallop.py b/src/apideck_unify/models/accounting_billsallop.py index abb1bf14..6000e080 100644 --- a/src/apideck_unify/models/accounting_billsallop.py +++ b/src/apideck_unify/models/accounting_billsallop.py @@ -49,6 +49,10 @@ class AccountingBillsAllGlobals(BaseModel): class AccountingBillsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingBillsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class AccountingBillsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_billsdeleteop.py b/src/apideck_unify/models/accounting_billsdeleteop.py index a002244a..06eb3d0c 100644 --- a/src/apideck_unify/models/accounting_billsdeleteop.py +++ b/src/apideck_unify/models/accounting_billsdeleteop.py @@ -45,6 +45,10 @@ class AccountingBillsDeleteGlobals(BaseModel): class AccountingBillsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingBillsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_billsoneop.py b/src/apideck_unify/models/accounting_billsoneop.py index 7105525c..0c29e8d8 100644 --- a/src/apideck_unify/models/accounting_billsoneop.py +++ b/src/apideck_unify/models/accounting_billsoneop.py @@ -52,6 +52,10 @@ class AccountingBillsOneGlobals(BaseModel): class AccountingBillsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingBillsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingBillsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_billsupdateop.py b/src/apideck_unify/models/accounting_billsupdateop.py index f64f3f08..10a36a78 100644 --- a/src/apideck_unify/models/accounting_billsupdateop.py +++ b/src/apideck_unify/models/accounting_billsupdateop.py @@ -48,6 +48,10 @@ class AccountingBillsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" bill: BillInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -64,6 +68,20 @@ class AccountingBillsUpdateRequest(BaseModel): BillInput, FieldMetadata(request=RequestMetadata(media_type="application/json")) ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_companyinfooneop.py b/src/apideck_unify/models/accounting_companyinfooneop.py index b552389b..bcebe3e2 100644 --- a/src/apideck_unify/models/accounting_companyinfooneop.py +++ b/src/apideck_unify/models/accounting_companyinfooneop.py @@ -50,6 +50,10 @@ class AccountingCompanyInfoOneGlobals(BaseModel): class AccountingCompanyInfoOneRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -63,6 +67,20 @@ class AccountingCompanyInfoOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -78,7 +96,7 @@ class AccountingCompanyInfoOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "fields"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_creditnotesaddop.py b/src/apideck_unify/models/accounting_creditnotesaddop.py index 4d451071..18562322 100644 --- a/src/apideck_unify/models/accounting_creditnotesaddop.py +++ b/src/apideck_unify/models/accounting_creditnotesaddop.py @@ -50,6 +50,10 @@ class AccountingCreditNotesAddRequestTypedDict(TypedDict): credit_note: CreditNoteInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingCreditNotesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_creditnotesallop.py b/src/apideck_unify/models/accounting_creditnotesallop.py index d0d0f815..241cb3e7 100644 --- a/src/apideck_unify/models/accounting_creditnotesallop.py +++ b/src/apideck_unify/models/accounting_creditnotesallop.py @@ -52,6 +52,10 @@ class AccountingCreditNotesAllGlobals(BaseModel): class AccountingCreditNotesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class AccountingCreditNotesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class AccountingCreditNotesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_creditnotesdeleteop.py b/src/apideck_unify/models/accounting_creditnotesdeleteop.py index 7f2fc3ca..2a0dcf7a 100644 --- a/src/apideck_unify/models/accounting_creditnotesdeleteop.py +++ b/src/apideck_unify/models/accounting_creditnotesdeleteop.py @@ -48,6 +48,10 @@ class AccountingCreditNotesDeleteGlobals(BaseModel): class AccountingCreditNotesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingCreditNotesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_creditnotesoneop.py b/src/apideck_unify/models/accounting_creditnotesoneop.py index 14332127..e284ddcd 100644 --- a/src/apideck_unify/models/accounting_creditnotesoneop.py +++ b/src/apideck_unify/models/accounting_creditnotesoneop.py @@ -52,6 +52,10 @@ class AccountingCreditNotesOneGlobals(BaseModel): class AccountingCreditNotesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingCreditNotesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingCreditNotesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_creditnotesupdateop.py b/src/apideck_unify/models/accounting_creditnotesupdateop.py index 880e5ceb..6a3125c5 100644 --- a/src/apideck_unify/models/accounting_creditnotesupdateop.py +++ b/src/apideck_unify/models/accounting_creditnotesupdateop.py @@ -51,6 +51,10 @@ class AccountingCreditNotesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" credit_note: CreditNoteInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingCreditNotesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_customersaddop.py b/src/apideck_unify/models/accounting_customersaddop.py index 3a95747a..d125a78b 100644 --- a/src/apideck_unify/models/accounting_customersaddop.py +++ b/src/apideck_unify/models/accounting_customersaddop.py @@ -50,6 +50,10 @@ class AccountingCustomersAddRequestTypedDict(TypedDict): customer: CustomerInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingCustomersAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_customersallop.py b/src/apideck_unify/models/accounting_customersallop.py index 33d1e34b..01a806da 100644 --- a/src/apideck_unify/models/accounting_customersallop.py +++ b/src/apideck_unify/models/accounting_customersallop.py @@ -49,6 +49,10 @@ class AccountingCustomersAllGlobals(BaseModel): class AccountingCustomersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingCustomersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class AccountingCustomersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_customersdeleteop.py b/src/apideck_unify/models/accounting_customersdeleteop.py index c2d33472..ccfaff0e 100644 --- a/src/apideck_unify/models/accounting_customersdeleteop.py +++ b/src/apideck_unify/models/accounting_customersdeleteop.py @@ -48,6 +48,10 @@ class AccountingCustomersDeleteGlobals(BaseModel): class AccountingCustomersDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingCustomersDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_customersoneop.py b/src/apideck_unify/models/accounting_customersoneop.py index 9127ac28..e0cb49c9 100644 --- a/src/apideck_unify/models/accounting_customersoneop.py +++ b/src/apideck_unify/models/accounting_customersoneop.py @@ -52,6 +52,10 @@ class AccountingCustomersOneGlobals(BaseModel): class AccountingCustomersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingCustomersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingCustomersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_customersupdateop.py b/src/apideck_unify/models/accounting_customersupdateop.py index 6a725d8d..215ffd69 100644 --- a/src/apideck_unify/models/accounting_customersupdateop.py +++ b/src/apideck_unify/models/accounting_customersupdateop.py @@ -51,6 +51,10 @@ class AccountingCustomersUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" customer: CustomerInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingCustomersUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_departmentsaddop.py b/src/apideck_unify/models/accounting_departmentsaddop.py index 0b87ebb9..b3bb8cc1 100644 --- a/src/apideck_unify/models/accounting_departmentsaddop.py +++ b/src/apideck_unify/models/accounting_departmentsaddop.py @@ -53,6 +53,10 @@ class AccountingDepartmentsAddRequestTypedDict(TypedDict): accounting_department: AccountingDepartmentInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -69,6 +73,20 @@ class AccountingDepartmentsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_departmentsallop.py b/src/apideck_unify/models/accounting_departmentsallop.py index 3d044d6b..34817e3c 100644 --- a/src/apideck_unify/models/accounting_departmentsallop.py +++ b/src/apideck_unify/models/accounting_departmentsallop.py @@ -54,6 +54,10 @@ class AccountingDepartmentsAllGlobals(BaseModel): class AccountingDepartmentsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -73,6 +77,20 @@ class AccountingDepartmentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -107,7 +125,16 @@ class AccountingDepartmentsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields", "filter"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + "filter", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_departmentsdeleteop.py b/src/apideck_unify/models/accounting_departmentsdeleteop.py index 58eb301d..10a19994 100644 --- a/src/apideck_unify/models/accounting_departmentsdeleteop.py +++ b/src/apideck_unify/models/accounting_departmentsdeleteop.py @@ -48,6 +48,10 @@ class AccountingDepartmentsDeleteGlobals(BaseModel): class AccountingDepartmentsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingDepartmentsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_departmentsoneop.py b/src/apideck_unify/models/accounting_departmentsoneop.py index 63ade953..91a5ee1a 100644 --- a/src/apideck_unify/models/accounting_departmentsoneop.py +++ b/src/apideck_unify/models/accounting_departmentsoneop.py @@ -55,6 +55,10 @@ class AccountingDepartmentsOneGlobals(BaseModel): class AccountingDepartmentsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingDepartmentsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingDepartmentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_departmentsupdateop.py b/src/apideck_unify/models/accounting_departmentsupdateop.py index 5c3d3c0c..8a814c40 100644 --- a/src/apideck_unify/models/accounting_departmentsupdateop.py +++ b/src/apideck_unify/models/accounting_departmentsupdateop.py @@ -54,6 +54,10 @@ class AccountingDepartmentsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" accounting_department: AccountingDepartmentInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -71,6 +75,20 @@ class AccountingDepartmentsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_expensesaddop.py b/src/apideck_unify/models/accounting_expensesaddop.py index 2f58ea17..57f190d1 100644 --- a/src/apideck_unify/models/accounting_expensesaddop.py +++ b/src/apideck_unify/models/accounting_expensesaddop.py @@ -47,6 +47,10 @@ class AccountingExpensesAddRequestTypedDict(TypedDict): expense: ExpenseInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class AccountingExpensesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_expensesallop.py b/src/apideck_unify/models/accounting_expensesallop.py index 022e90b8..8dcca501 100644 --- a/src/apideck_unify/models/accounting_expensesallop.py +++ b/src/apideck_unify/models/accounting_expensesallop.py @@ -47,6 +47,10 @@ class AccountingExpensesAllGlobals(BaseModel): class AccountingExpensesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -62,6 +66,20 @@ class AccountingExpensesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -83,7 +101,7 @@ class AccountingExpensesAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "cursor", "limit"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_expensesdeleteop.py b/src/apideck_unify/models/accounting_expensesdeleteop.py index 137ec7a6..bf56f214 100644 --- a/src/apideck_unify/models/accounting_expensesdeleteop.py +++ b/src/apideck_unify/models/accounting_expensesdeleteop.py @@ -45,6 +45,10 @@ class AccountingExpensesDeleteGlobals(BaseModel): class AccountingExpensesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingExpensesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_expensesoneop.py b/src/apideck_unify/models/accounting_expensesoneop.py index fcace8f4..49223a23 100644 --- a/src/apideck_unify/models/accounting_expensesoneop.py +++ b/src/apideck_unify/models/accounting_expensesoneop.py @@ -45,6 +45,10 @@ class AccountingExpensesOneGlobals(BaseModel): class AccountingExpensesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingExpensesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_expensesupdateop.py b/src/apideck_unify/models/accounting_expensesupdateop.py index 895d4b48..640901e4 100644 --- a/src/apideck_unify/models/accounting_expensesupdateop.py +++ b/src/apideck_unify/models/accounting_expensesupdateop.py @@ -48,6 +48,10 @@ class AccountingExpensesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" expense: ExpenseInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class AccountingExpensesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoiceitemsaddop.py b/src/apideck_unify/models/accounting_invoiceitemsaddop.py index 57ec6254..04361a33 100644 --- a/src/apideck_unify/models/accounting_invoiceitemsaddop.py +++ b/src/apideck_unify/models/accounting_invoiceitemsaddop.py @@ -50,6 +50,10 @@ class AccountingInvoiceItemsAddRequestTypedDict(TypedDict): invoice_item: InvoiceItemInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingInvoiceItemsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoiceitemsallop.py b/src/apideck_unify/models/accounting_invoiceitemsallop.py index 87cdad4b..7fbef1f1 100644 --- a/src/apideck_unify/models/accounting_invoiceitemsallop.py +++ b/src/apideck_unify/models/accounting_invoiceitemsallop.py @@ -51,6 +51,10 @@ class AccountingInvoiceItemsAllGlobals(BaseModel): class AccountingInvoiceItemsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingInvoiceItemsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -114,6 +132,8 @@ class AccountingInvoiceItemsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_invoiceitemsdeleteop.py b/src/apideck_unify/models/accounting_invoiceitemsdeleteop.py index bef28228..10e16a35 100644 --- a/src/apideck_unify/models/accounting_invoiceitemsdeleteop.py +++ b/src/apideck_unify/models/accounting_invoiceitemsdeleteop.py @@ -45,6 +45,10 @@ class AccountingInvoiceItemsDeleteGlobals(BaseModel): class AccountingInvoiceItemsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingInvoiceItemsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoiceitemsoneop.py b/src/apideck_unify/models/accounting_invoiceitemsoneop.py index f9e06e55..58f3855a 100644 --- a/src/apideck_unify/models/accounting_invoiceitemsoneop.py +++ b/src/apideck_unify/models/accounting_invoiceitemsoneop.py @@ -56,6 +56,10 @@ class AccountingInvoiceItemsOneGlobals(BaseModel): class AccountingInvoiceItemsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -72,6 +76,20 @@ class AccountingInvoiceItemsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -100,7 +118,14 @@ class AccountingInvoiceItemsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields", "filter"] + optional_fields = [ + "consumerId", + "appId", + "serviceId", + "raw", + "fields", + "filter", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_invoiceitemsupdateop.py b/src/apideck_unify/models/accounting_invoiceitemsupdateop.py index 8234ea24..9cb5bd73 100644 --- a/src/apideck_unify/models/accounting_invoiceitemsupdateop.py +++ b/src/apideck_unify/models/accounting_invoiceitemsupdateop.py @@ -51,6 +51,10 @@ class AccountingInvoiceItemsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" invoice_item: InvoiceItemInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingInvoiceItemsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoicesaddop.py b/src/apideck_unify/models/accounting_invoicesaddop.py index 2f9b2e80..c9da6e2d 100644 --- a/src/apideck_unify/models/accounting_invoicesaddop.py +++ b/src/apideck_unify/models/accounting_invoicesaddop.py @@ -47,6 +47,10 @@ class AccountingInvoicesAddRequestTypedDict(TypedDict): invoice: InvoiceInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class AccountingInvoicesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoicesallop.py b/src/apideck_unify/models/accounting_invoicesallop.py index e16698ed..8cea606e 100644 --- a/src/apideck_unify/models/accounting_invoicesallop.py +++ b/src/apideck_unify/models/accounting_invoicesallop.py @@ -49,6 +49,10 @@ class AccountingInvoicesAllGlobals(BaseModel): class AccountingInvoicesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingInvoicesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class AccountingInvoicesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_invoicesdeleteop.py b/src/apideck_unify/models/accounting_invoicesdeleteop.py index 71fdce6c..babb0676 100644 --- a/src/apideck_unify/models/accounting_invoicesdeleteop.py +++ b/src/apideck_unify/models/accounting_invoicesdeleteop.py @@ -45,6 +45,10 @@ class AccountingInvoicesDeleteGlobals(BaseModel): class AccountingInvoicesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingInvoicesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_invoicesoneop.py b/src/apideck_unify/models/accounting_invoicesoneop.py index 14aec796..0bb36c31 100644 --- a/src/apideck_unify/models/accounting_invoicesoneop.py +++ b/src/apideck_unify/models/accounting_invoicesoneop.py @@ -52,6 +52,10 @@ class AccountingInvoicesOneGlobals(BaseModel): class AccountingInvoicesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingInvoicesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingInvoicesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_invoicesupdateop.py b/src/apideck_unify/models/accounting_invoicesupdateop.py index a46ead23..ab2ba0a6 100644 --- a/src/apideck_unify/models/accounting_invoicesupdateop.py +++ b/src/apideck_unify/models/accounting_invoicesupdateop.py @@ -48,6 +48,10 @@ class AccountingInvoicesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" invoice: InvoiceInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class AccountingInvoicesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_journalentriesaddop.py b/src/apideck_unify/models/accounting_journalentriesaddop.py index 6d66f761..38070841 100644 --- a/src/apideck_unify/models/accounting_journalentriesaddop.py +++ b/src/apideck_unify/models/accounting_journalentriesaddop.py @@ -50,6 +50,10 @@ class AccountingJournalEntriesAddRequestTypedDict(TypedDict): journal_entry: JournalEntryInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingJournalEntriesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_journalentriesallop.py b/src/apideck_unify/models/accounting_journalentriesallop.py index a6102149..2221f788 100644 --- a/src/apideck_unify/models/accounting_journalentriesallop.py +++ b/src/apideck_unify/models/accounting_journalentriesallop.py @@ -52,6 +52,10 @@ class AccountingJournalEntriesAllGlobals(BaseModel): class AccountingJournalEntriesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class AccountingJournalEntriesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class AccountingJournalEntriesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_journalentriesdeleteop.py b/src/apideck_unify/models/accounting_journalentriesdeleteop.py index f6f82220..765c5f6c 100644 --- a/src/apideck_unify/models/accounting_journalentriesdeleteop.py +++ b/src/apideck_unify/models/accounting_journalentriesdeleteop.py @@ -48,6 +48,10 @@ class AccountingJournalEntriesDeleteGlobals(BaseModel): class AccountingJournalEntriesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingJournalEntriesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_journalentriesoneop.py b/src/apideck_unify/models/accounting_journalentriesoneop.py index 5d1a5fe8..11d4d9aa 100644 --- a/src/apideck_unify/models/accounting_journalentriesoneop.py +++ b/src/apideck_unify/models/accounting_journalentriesoneop.py @@ -55,6 +55,10 @@ class AccountingJournalEntriesOneGlobals(BaseModel): class AccountingJournalEntriesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingJournalEntriesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingJournalEntriesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_journalentriesupdateop.py b/src/apideck_unify/models/accounting_journalentriesupdateop.py index ea978831..a77c9ee0 100644 --- a/src/apideck_unify/models/accounting_journalentriesupdateop.py +++ b/src/apideck_unify/models/accounting_journalentriesupdateop.py @@ -51,6 +51,10 @@ class AccountingJournalEntriesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" journal_entry: JournalEntryInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingJournalEntriesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_ledgeraccountsaddop.py b/src/apideck_unify/models/accounting_ledgeraccountsaddop.py index c6cedd9e..53e4df86 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsaddop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsaddop.py @@ -50,6 +50,10 @@ class AccountingLedgerAccountsAddRequestTypedDict(TypedDict): ledger_account: LedgerAccountInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingLedgerAccountsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_ledgeraccountsallop.py b/src/apideck_unify/models/accounting_ledgeraccountsallop.py index 0724cfc1..015a66ba 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsallop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsallop.py @@ -52,6 +52,10 @@ class AccountingLedgerAccountsAllGlobals(BaseModel): class AccountingLedgerAccountsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class AccountingLedgerAccountsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class AccountingLedgerAccountsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_ledgeraccountsdeleteop.py b/src/apideck_unify/models/accounting_ledgeraccountsdeleteop.py index 616fde12..3fabeedd 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsdeleteop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsdeleteop.py @@ -48,6 +48,10 @@ class AccountingLedgerAccountsDeleteGlobals(BaseModel): class AccountingLedgerAccountsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingLedgerAccountsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_ledgeraccountsoneop.py b/src/apideck_unify/models/accounting_ledgeraccountsoneop.py index 3c110fd9..0144bd1f 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsoneop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsoneop.py @@ -55,6 +55,10 @@ class AccountingLedgerAccountsOneGlobals(BaseModel): class AccountingLedgerAccountsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingLedgerAccountsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingLedgerAccountsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py b/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py index 9e67cad1..556c1597 100644 --- a/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py +++ b/src/apideck_unify/models/accounting_ledgeraccountsupdateop.py @@ -51,6 +51,10 @@ class AccountingLedgerAccountsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" ledger_account: LedgerAccountInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingLedgerAccountsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_locationsaddop.py b/src/apideck_unify/models/accounting_locationsaddop.py index b1d0d92c..8223a403 100644 --- a/src/apideck_unify/models/accounting_locationsaddop.py +++ b/src/apideck_unify/models/accounting_locationsaddop.py @@ -53,6 +53,10 @@ class AccountingLocationsAddRequestTypedDict(TypedDict): accounting_location: AccountingLocationInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -69,6 +73,20 @@ class AccountingLocationsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_locationsallop.py b/src/apideck_unify/models/accounting_locationsallop.py index d5fb161b..1f1a788f 100644 --- a/src/apideck_unify/models/accounting_locationsallop.py +++ b/src/apideck_unify/models/accounting_locationsallop.py @@ -54,6 +54,10 @@ class AccountingLocationsAllGlobals(BaseModel): class AccountingLocationsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -73,6 +77,20 @@ class AccountingLocationsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -107,7 +125,16 @@ class AccountingLocationsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields", "filter"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + "filter", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_locationsdeleteop.py b/src/apideck_unify/models/accounting_locationsdeleteop.py index d5cf2d63..849573b4 100644 --- a/src/apideck_unify/models/accounting_locationsdeleteop.py +++ b/src/apideck_unify/models/accounting_locationsdeleteop.py @@ -48,6 +48,10 @@ class AccountingLocationsDeleteGlobals(BaseModel): class AccountingLocationsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingLocationsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_locationsoneop.py b/src/apideck_unify/models/accounting_locationsoneop.py index a2dc5bfe..15f87777 100644 --- a/src/apideck_unify/models/accounting_locationsoneop.py +++ b/src/apideck_unify/models/accounting_locationsoneop.py @@ -55,6 +55,10 @@ class AccountingLocationsOneGlobals(BaseModel): class AccountingLocationsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingLocationsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingLocationsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_locationsupdateop.py b/src/apideck_unify/models/accounting_locationsupdateop.py index 38cbbc5c..02c0df99 100644 --- a/src/apideck_unify/models/accounting_locationsupdateop.py +++ b/src/apideck_unify/models/accounting_locationsupdateop.py @@ -54,6 +54,10 @@ class AccountingLocationsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" accounting_location: AccountingLocationInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -71,6 +75,20 @@ class AccountingLocationsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_paymentsaddop.py b/src/apideck_unify/models/accounting_paymentsaddop.py index 80ff3d7b..c0f49e4f 100644 --- a/src/apideck_unify/models/accounting_paymentsaddop.py +++ b/src/apideck_unify/models/accounting_paymentsaddop.py @@ -47,6 +47,10 @@ class AccountingPaymentsAddRequestTypedDict(TypedDict): payment: PaymentInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class AccountingPaymentsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_paymentsallop.py b/src/apideck_unify/models/accounting_paymentsallop.py index bd810bb7..f58d3957 100644 --- a/src/apideck_unify/models/accounting_paymentsallop.py +++ b/src/apideck_unify/models/accounting_paymentsallop.py @@ -49,6 +49,10 @@ class AccountingPaymentsAllGlobals(BaseModel): class AccountingPaymentsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingPaymentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class AccountingPaymentsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_paymentsdeleteop.py b/src/apideck_unify/models/accounting_paymentsdeleteop.py index f97763e3..9ff9a437 100644 --- a/src/apideck_unify/models/accounting_paymentsdeleteop.py +++ b/src/apideck_unify/models/accounting_paymentsdeleteop.py @@ -45,6 +45,10 @@ class AccountingPaymentsDeleteGlobals(BaseModel): class AccountingPaymentsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingPaymentsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_paymentsoneop.py b/src/apideck_unify/models/accounting_paymentsoneop.py index a9d6d457..36caff00 100644 --- a/src/apideck_unify/models/accounting_paymentsoneop.py +++ b/src/apideck_unify/models/accounting_paymentsoneop.py @@ -52,6 +52,10 @@ class AccountingPaymentsOneGlobals(BaseModel): class AccountingPaymentsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingPaymentsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingPaymentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_paymentsupdateop.py b/src/apideck_unify/models/accounting_paymentsupdateop.py index 37cae492..01400406 100644 --- a/src/apideck_unify/models/accounting_paymentsupdateop.py +++ b/src/apideck_unify/models/accounting_paymentsupdateop.py @@ -48,6 +48,10 @@ class AccountingPaymentsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" payment: PaymentInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class AccountingPaymentsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_profitandlossoneop.py b/src/apideck_unify/models/accounting_profitandlossoneop.py index d099c8da..d695d0d5 100644 --- a/src/apideck_unify/models/accounting_profitandlossoneop.py +++ b/src/apideck_unify/models/accounting_profitandlossoneop.py @@ -51,6 +51,10 @@ class AccountingProfitAndLossOneGlobals(BaseModel): class AccountingProfitAndLossOneRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" filter_: NotRequired[ProfitAndLossFilterTypedDict] @@ -68,6 +72,20 @@ class AccountingProfitAndLossOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -96,7 +114,15 @@ class AccountingProfitAndLossOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "filter", "pass_through", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "filter", + "pass_through", + "fields", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_purchaseordersaddop.py b/src/apideck_unify/models/accounting_purchaseordersaddop.py index 1ee805db..e8cbf1c7 100644 --- a/src/apideck_unify/models/accounting_purchaseordersaddop.py +++ b/src/apideck_unify/models/accounting_purchaseordersaddop.py @@ -50,6 +50,10 @@ class AccountingPurchaseOrdersAddRequestTypedDict(TypedDict): purchase_order: PurchaseOrderInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingPurchaseOrdersAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_purchaseordersallop.py b/src/apideck_unify/models/accounting_purchaseordersallop.py index 6ff9e620..cd962480 100644 --- a/src/apideck_unify/models/accounting_purchaseordersallop.py +++ b/src/apideck_unify/models/accounting_purchaseordersallop.py @@ -52,6 +52,10 @@ class AccountingPurchaseOrdersAllGlobals(BaseModel): class AccountingPurchaseOrdersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -73,6 +77,20 @@ class AccountingPurchaseOrdersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -115,6 +133,8 @@ class AccountingPurchaseOrdersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "pass_through", diff --git a/src/apideck_unify/models/accounting_purchaseordersdeleteop.py b/src/apideck_unify/models/accounting_purchaseordersdeleteop.py index 4a620478..767c2077 100644 --- a/src/apideck_unify/models/accounting_purchaseordersdeleteop.py +++ b/src/apideck_unify/models/accounting_purchaseordersdeleteop.py @@ -48,6 +48,10 @@ class AccountingPurchaseOrdersDeleteGlobals(BaseModel): class AccountingPurchaseOrdersDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingPurchaseOrdersDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_purchaseordersoneop.py b/src/apideck_unify/models/accounting_purchaseordersoneop.py index 8b260613..19c085b3 100644 --- a/src/apideck_unify/models/accounting_purchaseordersoneop.py +++ b/src/apideck_unify/models/accounting_purchaseordersoneop.py @@ -48,6 +48,10 @@ class AccountingPurchaseOrdersOneGlobals(BaseModel): class AccountingPurchaseOrdersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingPurchaseOrdersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_purchaseordersupdateop.py b/src/apideck_unify/models/accounting_purchaseordersupdateop.py index 6927797d..99509f89 100644 --- a/src/apideck_unify/models/accounting_purchaseordersupdateop.py +++ b/src/apideck_unify/models/accounting_purchaseordersupdateop.py @@ -51,6 +51,10 @@ class AccountingPurchaseOrdersUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" purchase_order: PurchaseOrderInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingPurchaseOrdersUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_subsidiariesaddop.py b/src/apideck_unify/models/accounting_subsidiariesaddop.py index b59d9ff6..5dbfda4a 100644 --- a/src/apideck_unify/models/accounting_subsidiariesaddop.py +++ b/src/apideck_unify/models/accounting_subsidiariesaddop.py @@ -50,6 +50,10 @@ class AccountingSubsidiariesAddRequestTypedDict(TypedDict): subsidiary: SubsidiaryInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingSubsidiariesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_subsidiariesallop.py b/src/apideck_unify/models/accounting_subsidiariesallop.py index 9385b9f6..395653f7 100644 --- a/src/apideck_unify/models/accounting_subsidiariesallop.py +++ b/src/apideck_unify/models/accounting_subsidiariesallop.py @@ -50,6 +50,10 @@ class AccountingSubsidiariesAllGlobals(BaseModel): class AccountingSubsidiariesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -67,6 +71,20 @@ class AccountingSubsidiariesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -94,7 +112,15 @@ class AccountingSubsidiariesAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_subsidiariesdeleteop.py b/src/apideck_unify/models/accounting_subsidiariesdeleteop.py index 702e3ac1..e1b3bb2b 100644 --- a/src/apideck_unify/models/accounting_subsidiariesdeleteop.py +++ b/src/apideck_unify/models/accounting_subsidiariesdeleteop.py @@ -48,6 +48,10 @@ class AccountingSubsidiariesDeleteGlobals(BaseModel): class AccountingSubsidiariesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingSubsidiariesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_subsidiariesoneop.py b/src/apideck_unify/models/accounting_subsidiariesoneop.py index fb81ef3c..804d4e84 100644 --- a/src/apideck_unify/models/accounting_subsidiariesoneop.py +++ b/src/apideck_unify/models/accounting_subsidiariesoneop.py @@ -52,6 +52,10 @@ class AccountingSubsidiariesOneGlobals(BaseModel): class AccountingSubsidiariesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingSubsidiariesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingSubsidiariesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_subsidiariesupdateop.py b/src/apideck_unify/models/accounting_subsidiariesupdateop.py index 8477783f..c58dff16 100644 --- a/src/apideck_unify/models/accounting_subsidiariesupdateop.py +++ b/src/apideck_unify/models/accounting_subsidiariesupdateop.py @@ -51,6 +51,10 @@ class AccountingSubsidiariesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" subsidiary: SubsidiaryInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingSubsidiariesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_suppliersaddop.py b/src/apideck_unify/models/accounting_suppliersaddop.py index bc0257f1..2afe8b36 100644 --- a/src/apideck_unify/models/accounting_suppliersaddop.py +++ b/src/apideck_unify/models/accounting_suppliersaddop.py @@ -50,6 +50,10 @@ class AccountingSuppliersAddRequestTypedDict(TypedDict): supplier: SupplierInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingSuppliersAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_suppliersallop.py b/src/apideck_unify/models/accounting_suppliersallop.py index 491dfe1e..5944cda1 100644 --- a/src/apideck_unify/models/accounting_suppliersallop.py +++ b/src/apideck_unify/models/accounting_suppliersallop.py @@ -49,6 +49,10 @@ class AccountingSuppliersAllGlobals(BaseModel): class AccountingSuppliersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class AccountingSuppliersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class AccountingSuppliersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_suppliersdeleteop.py b/src/apideck_unify/models/accounting_suppliersdeleteop.py index fba8665e..bb298d2a 100644 --- a/src/apideck_unify/models/accounting_suppliersdeleteop.py +++ b/src/apideck_unify/models/accounting_suppliersdeleteop.py @@ -48,6 +48,10 @@ class AccountingSuppliersDeleteGlobals(BaseModel): class AccountingSuppliersDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingSuppliersDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_suppliersoneop.py b/src/apideck_unify/models/accounting_suppliersoneop.py index caf74276..7a8a1e98 100644 --- a/src/apideck_unify/models/accounting_suppliersoneop.py +++ b/src/apideck_unify/models/accounting_suppliersoneop.py @@ -52,6 +52,10 @@ class AccountingSuppliersOneGlobals(BaseModel): class AccountingSuppliersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingSuppliersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingSuppliersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_suppliersupdateop.py b/src/apideck_unify/models/accounting_suppliersupdateop.py index 967ec862..b12e4dac 100644 --- a/src/apideck_unify/models/accounting_suppliersupdateop.py +++ b/src/apideck_unify/models/accounting_suppliersupdateop.py @@ -51,6 +51,10 @@ class AccountingSuppliersUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" supplier: SupplierInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingSuppliersUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_taxratesaddop.py b/src/apideck_unify/models/accounting_taxratesaddop.py index 7e2ea1f6..0a0ec06d 100644 --- a/src/apideck_unify/models/accounting_taxratesaddop.py +++ b/src/apideck_unify/models/accounting_taxratesaddop.py @@ -47,6 +47,10 @@ class AccountingTaxRatesAddRequestTypedDict(TypedDict): tax_rate: TaxRateInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class AccountingTaxRatesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_taxratesallop.py b/src/apideck_unify/models/accounting_taxratesallop.py index 8c727e39..2b128cbe 100644 --- a/src/apideck_unify/models/accounting_taxratesallop.py +++ b/src/apideck_unify/models/accounting_taxratesallop.py @@ -48,6 +48,10 @@ class AccountingTaxRatesAllGlobals(BaseModel): class AccountingTaxRatesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class AccountingTaxRatesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -111,6 +129,8 @@ class AccountingTaxRatesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_taxratesdeleteop.py b/src/apideck_unify/models/accounting_taxratesdeleteop.py index 65c215b5..16fcf082 100644 --- a/src/apideck_unify/models/accounting_taxratesdeleteop.py +++ b/src/apideck_unify/models/accounting_taxratesdeleteop.py @@ -45,6 +45,10 @@ class AccountingTaxRatesDeleteGlobals(BaseModel): class AccountingTaxRatesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class AccountingTaxRatesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_taxratesoneop.py b/src/apideck_unify/models/accounting_taxratesoneop.py index 1ce2407a..7ae4f28f 100644 --- a/src/apideck_unify/models/accounting_taxratesoneop.py +++ b/src/apideck_unify/models/accounting_taxratesoneop.py @@ -52,6 +52,10 @@ class AccountingTaxRatesOneGlobals(BaseModel): class AccountingTaxRatesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AccountingTaxRatesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AccountingTaxRatesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_taxratesupdateop.py b/src/apideck_unify/models/accounting_taxratesupdateop.py index 005c9a0e..c81edd7f 100644 --- a/src/apideck_unify/models/accounting_taxratesupdateop.py +++ b/src/apideck_unify/models/accounting_taxratesupdateop.py @@ -48,6 +48,10 @@ class AccountingTaxRatesUpdateRequestTypedDict(TypedDict): id_param: str r"""ID of the record you are acting upon.""" tax_rate: TaxRateInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -67,6 +71,20 @@ class AccountingTaxRatesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_trackingcategoriesaddop.py b/src/apideck_unify/models/accounting_trackingcategoriesaddop.py index 07741c9a..6108e1c7 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesaddop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesaddop.py @@ -50,6 +50,10 @@ class AccountingTrackingCategoriesAddRequestTypedDict(TypedDict): tracking_category: TrackingCategoryInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AccountingTrackingCategoriesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_trackingcategoriesallop.py b/src/apideck_unify/models/accounting_trackingcategoriesallop.py index 51a31ea4..a50b269f 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesallop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesallop.py @@ -50,6 +50,10 @@ class AccountingTrackingCategoriesAllGlobals(BaseModel): class AccountingTrackingCategoriesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class AccountingTrackingCategoriesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -104,6 +122,8 @@ class AccountingTrackingCategoriesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/accounting_trackingcategoriesdeleteop.py b/src/apideck_unify/models/accounting_trackingcategoriesdeleteop.py index 0eb35095..17706290 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesdeleteop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesdeleteop.py @@ -48,6 +48,10 @@ class AccountingTrackingCategoriesDeleteGlobals(BaseModel): class AccountingTrackingCategoriesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AccountingTrackingCategoriesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/accounting_trackingcategoriesoneop.py b/src/apideck_unify/models/accounting_trackingcategoriesoneop.py index cbe3bb4b..6e3649c1 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesoneop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesoneop.py @@ -55,6 +55,10 @@ class AccountingTrackingCategoriesOneGlobals(BaseModel): class AccountingTrackingCategoriesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class AccountingTrackingCategoriesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class AccountingTrackingCategoriesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py b/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py index 9f3f392b..4ac1abca 100644 --- a/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py +++ b/src/apideck_unify/models/accounting_trackingcategoriesupdateop.py @@ -51,6 +51,10 @@ class AccountingTrackingCategoriesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" tracking_category: TrackingCategoryInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AccountingTrackingCategoriesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicantsaddop.py b/src/apideck_unify/models/ats_applicantsaddop.py index 20ffaa40..a3e6df5b 100644 --- a/src/apideck_unify/models/ats_applicantsaddop.py +++ b/src/apideck_unify/models/ats_applicantsaddop.py @@ -50,6 +50,10 @@ class AtsApplicantsAddRequestTypedDict(TypedDict): applicant: ApplicantInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AtsApplicantsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicantsallop.py b/src/apideck_unify/models/ats_applicantsallop.py index 71d2860a..adf2962e 100644 --- a/src/apideck_unify/models/ats_applicantsallop.py +++ b/src/apideck_unify/models/ats_applicantsallop.py @@ -48,6 +48,10 @@ class AtsApplicantsAllGlobals(BaseModel): class AtsApplicantsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class AtsApplicantsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -111,6 +129,8 @@ class AtsApplicantsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/ats_applicantsdeleteop.py b/src/apideck_unify/models/ats_applicantsdeleteop.py index c171812f..d23492d1 100644 --- a/src/apideck_unify/models/ats_applicantsdeleteop.py +++ b/src/apideck_unify/models/ats_applicantsdeleteop.py @@ -48,6 +48,10 @@ class AtsApplicantsDeleteGlobals(BaseModel): class AtsApplicantsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AtsApplicantsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicantsoneop.py b/src/apideck_unify/models/ats_applicantsoneop.py index da2c78d6..ea61a23b 100644 --- a/src/apideck_unify/models/ats_applicantsoneop.py +++ b/src/apideck_unify/models/ats_applicantsoneop.py @@ -52,6 +52,10 @@ class AtsApplicantsOneGlobals(BaseModel): class AtsApplicantsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AtsApplicantsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AtsApplicantsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/ats_applicantsupdateop.py b/src/apideck_unify/models/ats_applicantsupdateop.py index ea19e515..520d4804 100644 --- a/src/apideck_unify/models/ats_applicantsupdateop.py +++ b/src/apideck_unify/models/ats_applicantsupdateop.py @@ -51,6 +51,10 @@ class AtsApplicantsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" applicant: ApplicantInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AtsApplicantsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicationsaddop.py b/src/apideck_unify/models/ats_applicationsaddop.py index 298c712e..84999be6 100644 --- a/src/apideck_unify/models/ats_applicationsaddop.py +++ b/src/apideck_unify/models/ats_applicationsaddop.py @@ -50,6 +50,10 @@ class AtsApplicationsAddRequestTypedDict(TypedDict): application: ApplicationInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class AtsApplicationsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicationsallop.py b/src/apideck_unify/models/ats_applicationsallop.py index 78549df6..ab0d299f 100644 --- a/src/apideck_unify/models/ats_applicationsallop.py +++ b/src/apideck_unify/models/ats_applicationsallop.py @@ -50,6 +50,10 @@ class AtsApplicationsAllGlobals(BaseModel): class AtsApplicationsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -67,6 +71,20 @@ class AtsApplicationsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -94,7 +112,15 @@ class AtsApplicationsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "pass_through", "limit"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "pass_through", + "limit", + ] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/ats_applicationsdeleteop.py b/src/apideck_unify/models/ats_applicationsdeleteop.py index 238b3224..1d3fec66 100644 --- a/src/apideck_unify/models/ats_applicationsdeleteop.py +++ b/src/apideck_unify/models/ats_applicationsdeleteop.py @@ -48,6 +48,10 @@ class AtsApplicationsDeleteGlobals(BaseModel): class AtsApplicationsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AtsApplicationsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicationsoneop.py b/src/apideck_unify/models/ats_applicationsoneop.py index 27795ce5..92ff335a 100644 --- a/src/apideck_unify/models/ats_applicationsoneop.py +++ b/src/apideck_unify/models/ats_applicationsoneop.py @@ -48,6 +48,10 @@ class AtsApplicationsOneGlobals(BaseModel): class AtsApplicationsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class AtsApplicationsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_applicationsupdateop.py b/src/apideck_unify/models/ats_applicationsupdateop.py index 3fd21ffc..1dd2b772 100644 --- a/src/apideck_unify/models/ats_applicationsupdateop.py +++ b/src/apideck_unify/models/ats_applicationsupdateop.py @@ -51,6 +51,10 @@ class AtsApplicationsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" application: ApplicationInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class AtsApplicationsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/ats_jobsallop.py b/src/apideck_unify/models/ats_jobsallop.py index bf7a0ad1..363611e5 100644 --- a/src/apideck_unify/models/ats_jobsallop.py +++ b/src/apideck_unify/models/ats_jobsallop.py @@ -47,6 +47,10 @@ class AtsJobsAllGlobals(BaseModel): class AtsJobsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -66,6 +70,20 @@ class AtsJobsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,6 +119,8 @@ class AtsJobsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/ats_jobsoneop.py b/src/apideck_unify/models/ats_jobsoneop.py index de1052ce..8ca9b01d 100644 --- a/src/apideck_unify/models/ats_jobsoneop.py +++ b/src/apideck_unify/models/ats_jobsoneop.py @@ -52,6 +52,10 @@ class AtsJobsOneGlobals(BaseModel): class AtsJobsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class AtsJobsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class AtsJobsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/connector_apiresourcecoverageoneop.py b/src/apideck_unify/models/connector_apiresourcecoverageoneop.py index 7cc7ca62..f1adb79a 100644 --- a/src/apideck_unify/models/connector_apiresourcecoverageoneop.py +++ b/src/apideck_unify/models/connector_apiresourcecoverageoneop.py @@ -36,6 +36,8 @@ class ConnectorAPIResourceCoverageOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" resource_id: str r"""ID of the resource you are acting upon.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class ConnectorAPIResourceCoverageOneRequest(BaseModel): @@ -49,6 +51,13 @@ class ConnectorAPIResourceCoverageOneRequest(BaseModel): ] r"""ID of the resource you are acting upon.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class ConnectorAPIResourceCoverageOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/connector_apiresourcesoneop.py b/src/apideck_unify/models/connector_apiresourcesoneop.py index cf4790b3..e6f75df6 100644 --- a/src/apideck_unify/models/connector_apiresourcesoneop.py +++ b/src/apideck_unify/models/connector_apiresourcesoneop.py @@ -36,6 +36,8 @@ class ConnectorAPIResourcesOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" resource_id: str r"""ID of the resource you are acting upon.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class ConnectorAPIResourcesOneRequest(BaseModel): @@ -49,6 +51,13 @@ class ConnectorAPIResourcesOneRequest(BaseModel): ] r"""ID of the resource you are acting upon.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class ConnectorAPIResourcesOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/connector_apisallop.py b/src/apideck_unify/models/connector_apisallop.py index 6d2c4c1d..a43316b2 100644 --- a/src/apideck_unify/models/connector_apisallop.py +++ b/src/apideck_unify/models/connector_apisallop.py @@ -37,6 +37,8 @@ class ConnectorApisAllGlobals(BaseModel): class ConnectorApisAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" cursor: NotRequired[Nullable[str]] r"""Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.""" limit: NotRequired[int] @@ -46,6 +48,13 @@ class ConnectorApisAllRequestTypedDict(TypedDict): class ConnectorApisAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + cursor: Annotated[ OptionalNullable[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -67,7 +76,7 @@ class ConnectorApisAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["cursor", "limit", "filter"] + optional_fields = ["appId", "cursor", "limit", "filter"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/connector_apisoneop.py b/src/apideck_unify/models/connector_apisoneop.py index ea7f5e55..44e4d837 100644 --- a/src/apideck_unify/models/connector_apisoneop.py +++ b/src/apideck_unify/models/connector_apisoneop.py @@ -31,6 +31,8 @@ class ConnectorApisOneGlobals(BaseModel): class ConnectorApisOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class ConnectorApisOneRequest(BaseModel): @@ -39,6 +41,13 @@ class ConnectorApisOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class ConnectorApisOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/connector_connectordocsoneop.py b/src/apideck_unify/models/connector_connectordocsoneop.py index 18627d5c..b37a6298 100644 --- a/src/apideck_unify/models/connector_connectordocsoneop.py +++ b/src/apideck_unify/models/connector_connectordocsoneop.py @@ -32,6 +32,8 @@ class ConnectorConnectorDocsOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" doc_id: str r"""ID of the Doc""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class ConnectorConnectorDocsOneRequest(BaseModel): @@ -45,6 +47,13 @@ class ConnectorConnectorDocsOneRequest(BaseModel): ] r"""ID of the Doc""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class ConnectorConnectorDocsOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/connector_connectorresourcesoneop.py b/src/apideck_unify/models/connector_connectorresourcesoneop.py index f15460f7..895bdfc0 100644 --- a/src/apideck_unify/models/connector_connectorresourcesoneop.py +++ b/src/apideck_unify/models/connector_connectorresourcesoneop.py @@ -42,6 +42,8 @@ class ConnectorConnectorResourcesOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" resource_id: str r"""ID of the resource you are acting upon.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" unified_api: NotRequired[UnifiedAPIID] r"""Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs""" @@ -57,6 +59,13 @@ class ConnectorConnectorResourcesOneRequest(BaseModel): ] r"""ID of the resource you are acting upon.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + unified_api: Annotated[ Optional[UnifiedAPIID], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), diff --git a/src/apideck_unify/models/connector_connectorsallop.py b/src/apideck_unify/models/connector_connectorsallop.py index 66cb67db..ce1b3017 100644 --- a/src/apideck_unify/models/connector_connectorsallop.py +++ b/src/apideck_unify/models/connector_connectorsallop.py @@ -37,6 +37,8 @@ class ConnectorConnectorsAllGlobals(BaseModel): class ConnectorConnectorsAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" cursor: NotRequired[Nullable[str]] r"""Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.""" limit: NotRequired[int] @@ -46,6 +48,13 @@ class ConnectorConnectorsAllRequestTypedDict(TypedDict): class ConnectorConnectorsAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + cursor: Annotated[ OptionalNullable[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -67,7 +76,7 @@ class ConnectorConnectorsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["cursor", "limit", "filter"] + optional_fields = ["appId", "cursor", "limit", "filter"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/connector_connectorsoneop.py b/src/apideck_unify/models/connector_connectorsoneop.py index a318a2dd..b56fa05d 100644 --- a/src/apideck_unify/models/connector_connectorsoneop.py +++ b/src/apideck_unify/models/connector_connectorsoneop.py @@ -31,6 +31,8 @@ class ConnectorConnectorsOneGlobals(BaseModel): class ConnectorConnectorsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class ConnectorConnectorsOneRequest(BaseModel): @@ -39,6 +41,13 @@ class ConnectorConnectorsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class ConnectorConnectorsOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/createaccountingdepartmentresponse.py b/src/apideck_unify/models/createaccountingdepartmentresponse.py index 1b7be9a8..171e06b6 100644 --- a/src/apideck_unify/models/createaccountingdepartmentresponse.py +++ b/src/apideck_unify/models/createaccountingdepartmentresponse.py @@ -20,6 +20,7 @@ class CreateAccountingDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateAccountingDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateAccountingDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createaccountinglocationresponse.py b/src/apideck_unify/models/createaccountinglocationresponse.py index 4ca951ba..bb5f22bf 100644 --- a/src/apideck_unify/models/createaccountinglocationresponse.py +++ b/src/apideck_unify/models/createaccountinglocationresponse.py @@ -20,6 +20,7 @@ class CreateAccountingLocationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateAccountingLocationResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateAccountingLocationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createactivityresponse.py b/src/apideck_unify/models/createactivityresponse.py index 4765f35d..f0c92699 100644 --- a/src/apideck_unify/models/createactivityresponse.py +++ b/src/apideck_unify/models/createactivityresponse.py @@ -20,6 +20,7 @@ class CreateActivityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateActivityResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateActivityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createapplicantresponse.py b/src/apideck_unify/models/createapplicantresponse.py index b34ff096..21219a42 100644 --- a/src/apideck_unify/models/createapplicantresponse.py +++ b/src/apideck_unify/models/createapplicantresponse.py @@ -20,6 +20,7 @@ class CreateApplicantResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateApplicantResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateApplicantResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createapplicationresponse.py b/src/apideck_unify/models/createapplicationresponse.py index 9855ccfa..61fd7a8e 100644 --- a/src/apideck_unify/models/createapplicationresponse.py +++ b/src/apideck_unify/models/createapplicationresponse.py @@ -20,6 +20,7 @@ class CreateApplicationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateApplicationResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateApplicationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createbillpaymentresponse.py b/src/apideck_unify/models/createbillpaymentresponse.py index 50a87cba..724bd089 100644 --- a/src/apideck_unify/models/createbillpaymentresponse.py +++ b/src/apideck_unify/models/createbillpaymentresponse.py @@ -20,6 +20,7 @@ class CreateBillPaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateBillPaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateBillPaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createbillresponse.py b/src/apideck_unify/models/createbillresponse.py index a870b6c4..25b4b2ff 100644 --- a/src/apideck_unify/models/createbillresponse.py +++ b/src/apideck_unify/models/createbillresponse.py @@ -20,6 +20,7 @@ class CreateBillResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateBillResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateBillResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createcommentresponse.py b/src/apideck_unify/models/createcommentresponse.py index 8cc759e2..3741257a 100644 --- a/src/apideck_unify/models/createcommentresponse.py +++ b/src/apideck_unify/models/createcommentresponse.py @@ -20,6 +20,7 @@ class CreateCommentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateCommentResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateCommentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createcompanyresponse.py b/src/apideck_unify/models/createcompanyresponse.py index fb0ffbeb..7e085aca 100644 --- a/src/apideck_unify/models/createcompanyresponse.py +++ b/src/apideck_unify/models/createcompanyresponse.py @@ -20,6 +20,7 @@ class CreateCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createcontactresponse.py b/src/apideck_unify/models/createcontactresponse.py index 57b06a5f..85d9e75a 100644 --- a/src/apideck_unify/models/createcontactresponse.py +++ b/src/apideck_unify/models/createcontactresponse.py @@ -20,6 +20,7 @@ class CreateContactResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateContactResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateContactResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createcreditnoteresponse.py b/src/apideck_unify/models/createcreditnoteresponse.py index de188a3e..c4408349 100644 --- a/src/apideck_unify/models/createcreditnoteresponse.py +++ b/src/apideck_unify/models/createcreditnoteresponse.py @@ -20,6 +20,7 @@ class CreateCreditNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateCreditNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateCreditNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createcustomerresponse.py b/src/apideck_unify/models/createcustomerresponse.py index d98245cd..9cbc4b73 100644 --- a/src/apideck_unify/models/createcustomerresponse.py +++ b/src/apideck_unify/models/createcustomerresponse.py @@ -20,6 +20,7 @@ class CreateCustomerResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateCustomerResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateCustomerResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createdepartmentresponse.py b/src/apideck_unify/models/createdepartmentresponse.py index 1a9573a2..3834627b 100644 --- a/src/apideck_unify/models/createdepartmentresponse.py +++ b/src/apideck_unify/models/createdepartmentresponse.py @@ -20,6 +20,7 @@ class CreateDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createdrivegroupresponse.py b/src/apideck_unify/models/createdrivegroupresponse.py index 8a3b62d5..40f1c3c8 100644 --- a/src/apideck_unify/models/createdrivegroupresponse.py +++ b/src/apideck_unify/models/createdrivegroupresponse.py @@ -20,6 +20,7 @@ class CreateDriveGroupResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateDriveGroupResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateDriveGroupResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createdriveresponse.py b/src/apideck_unify/models/createdriveresponse.py index 31189399..c34e9835 100644 --- a/src/apideck_unify/models/createdriveresponse.py +++ b/src/apideck_unify/models/createdriveresponse.py @@ -20,6 +20,7 @@ class CreateDriveResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateDriveResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateDriveResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createemployeeresponse.py b/src/apideck_unify/models/createemployeeresponse.py index c52a9635..3e66b7fe 100644 --- a/src/apideck_unify/models/createemployeeresponse.py +++ b/src/apideck_unify/models/createemployeeresponse.py @@ -20,6 +20,7 @@ class CreateEmployeeResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateEmployeeResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateEmployeeResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createexpenseresponse.py b/src/apideck_unify/models/createexpenseresponse.py index 31343a79..c650005e 100644 --- a/src/apideck_unify/models/createexpenseresponse.py +++ b/src/apideck_unify/models/createexpenseresponse.py @@ -20,6 +20,7 @@ class CreateExpenseResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateExpenseResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateExpenseResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createfolderresponse.py b/src/apideck_unify/models/createfolderresponse.py index 40d4f068..605c885a 100644 --- a/src/apideck_unify/models/createfolderresponse.py +++ b/src/apideck_unify/models/createfolderresponse.py @@ -20,6 +20,7 @@ class CreateFolderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateFolderResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateFolderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createhriscompanyresponse.py b/src/apideck_unify/models/createhriscompanyresponse.py index 00546342..61210044 100644 --- a/src/apideck_unify/models/createhriscompanyresponse.py +++ b/src/apideck_unify/models/createhriscompanyresponse.py @@ -20,6 +20,7 @@ class CreateHrisCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateHrisCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateHrisCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createinvoiceitemresponse.py b/src/apideck_unify/models/createinvoiceitemresponse.py index 73726a57..f44cff9e 100644 --- a/src/apideck_unify/models/createinvoiceitemresponse.py +++ b/src/apideck_unify/models/createinvoiceitemresponse.py @@ -20,6 +20,7 @@ class CreateInvoiceItemResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateInvoiceItemResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateInvoiceItemResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createjournalentryresponse.py b/src/apideck_unify/models/createjournalentryresponse.py index 11d3355b..d38c7f42 100644 --- a/src/apideck_unify/models/createjournalentryresponse.py +++ b/src/apideck_unify/models/createjournalentryresponse.py @@ -20,6 +20,7 @@ class CreateJournalEntryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateJournalEntryResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateJournalEntryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createleadresponse.py b/src/apideck_unify/models/createleadresponse.py index c4b0f95e..3e112fb1 100644 --- a/src/apideck_unify/models/createleadresponse.py +++ b/src/apideck_unify/models/createleadresponse.py @@ -20,6 +20,7 @@ class CreateLeadResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateLeadResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateLeadResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createledgeraccountresponse.py b/src/apideck_unify/models/createledgeraccountresponse.py index d47aa00e..5c6a93f5 100644 --- a/src/apideck_unify/models/createledgeraccountresponse.py +++ b/src/apideck_unify/models/createledgeraccountresponse.py @@ -20,6 +20,7 @@ class CreateLedgerAccountResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateLedgerAccountResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateLedgerAccountResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createmessageresponse.py b/src/apideck_unify/models/createmessageresponse.py index 2c36f3e8..d7634c98 100644 --- a/src/apideck_unify/models/createmessageresponse.py +++ b/src/apideck_unify/models/createmessageresponse.py @@ -20,6 +20,7 @@ class CreateMessageResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateMessageResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateMessageResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createnoteresponse.py b/src/apideck_unify/models/createnoteresponse.py index a0ad2a0e..ac14993d 100644 --- a/src/apideck_unify/models/createnoteresponse.py +++ b/src/apideck_unify/models/createnoteresponse.py @@ -20,6 +20,7 @@ class CreateNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createopportunityresponse.py b/src/apideck_unify/models/createopportunityresponse.py index de839b96..aa47cb96 100644 --- a/src/apideck_unify/models/createopportunityresponse.py +++ b/src/apideck_unify/models/createopportunityresponse.py @@ -20,6 +20,7 @@ class CreateOpportunityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateOpportunityResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateOpportunityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createpaymentresponse.py b/src/apideck_unify/models/createpaymentresponse.py index b0f1d4e2..10a1fbb5 100644 --- a/src/apideck_unify/models/createpaymentresponse.py +++ b/src/apideck_unify/models/createpaymentresponse.py @@ -20,6 +20,7 @@ class CreatePaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreatePaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class CreatePaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createpurchaseorderresponse.py b/src/apideck_unify/models/createpurchaseorderresponse.py index fd859454..83d5bc41 100644 --- a/src/apideck_unify/models/createpurchaseorderresponse.py +++ b/src/apideck_unify/models/createpurchaseorderresponse.py @@ -20,6 +20,7 @@ class CreatePurchaseOrderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreatePurchaseOrderResponse(BaseModel): @@ -41,3 +42,4 @@ class CreatePurchaseOrderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createsharedlinkresponse.py b/src/apideck_unify/models/createsharedlinkresponse.py index 3e8a7cc5..1f4bf822 100644 --- a/src/apideck_unify/models/createsharedlinkresponse.py +++ b/src/apideck_unify/models/createsharedlinkresponse.py @@ -20,6 +20,7 @@ class CreateSharedLinkResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateSharedLinkResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateSharedLinkResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createsubsidiaryresponse.py b/src/apideck_unify/models/createsubsidiaryresponse.py index 005a2e50..0a6c34ed 100644 --- a/src/apideck_unify/models/createsubsidiaryresponse.py +++ b/src/apideck_unify/models/createsubsidiaryresponse.py @@ -20,6 +20,7 @@ class CreateSubsidiaryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateSubsidiaryResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateSubsidiaryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createsupplierresponse.py b/src/apideck_unify/models/createsupplierresponse.py index 5e7a283b..24ab8aed 100644 --- a/src/apideck_unify/models/createsupplierresponse.py +++ b/src/apideck_unify/models/createsupplierresponse.py @@ -20,6 +20,7 @@ class CreateSupplierResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateSupplierResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateSupplierResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createtaxrateresponse.py b/src/apideck_unify/models/createtaxrateresponse.py index da70a311..0484184d 100644 --- a/src/apideck_unify/models/createtaxrateresponse.py +++ b/src/apideck_unify/models/createtaxrateresponse.py @@ -20,6 +20,7 @@ class CreateTaxRateResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateTaxRateResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateTaxRateResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createticketresponse.py b/src/apideck_unify/models/createticketresponse.py index fa1c5041..ea63b1e8 100644 --- a/src/apideck_unify/models/createticketresponse.py +++ b/src/apideck_unify/models/createticketresponse.py @@ -20,6 +20,7 @@ class CreateTicketResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateTicketResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateTicketResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createtimeoffrequestresponse.py b/src/apideck_unify/models/createtimeoffrequestresponse.py index 81300fc2..23590664 100644 --- a/src/apideck_unify/models/createtimeoffrequestresponse.py +++ b/src/apideck_unify/models/createtimeoffrequestresponse.py @@ -20,6 +20,7 @@ class CreateTimeOffRequestResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateTimeOffRequestResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateTimeOffRequestResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createtrackingcategoryresponse.py b/src/apideck_unify/models/createtrackingcategoryresponse.py index 63607586..b7f5a1b5 100644 --- a/src/apideck_unify/models/createtrackingcategoryresponse.py +++ b/src/apideck_unify/models/createtrackingcategoryresponse.py @@ -20,6 +20,7 @@ class CreateTrackingCategoryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateTrackingCategoryResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateTrackingCategoryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createuploadsessionresponse.py b/src/apideck_unify/models/createuploadsessionresponse.py index a23debc0..64f671e2 100644 --- a/src/apideck_unify/models/createuploadsessionresponse.py +++ b/src/apideck_unify/models/createuploadsessionresponse.py @@ -20,6 +20,7 @@ class CreateUploadSessionResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateUploadSessionResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateUploadSessionResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/createuserresponse.py b/src/apideck_unify/models/createuserresponse.py index cce21a47..7bee61d9 100644 --- a/src/apideck_unify/models/createuserresponse.py +++ b/src/apideck_unify/models/createuserresponse.py @@ -20,6 +20,7 @@ class CreateUserResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class CreateUserResponse(BaseModel): @@ -41,3 +42,4 @@ class CreateUserResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/crm_activitiesaddop.py b/src/apideck_unify/models/crm_activitiesaddop.py index 58db2f2a..e31da405 100644 --- a/src/apideck_unify/models/crm_activitiesaddop.py +++ b/src/apideck_unify/models/crm_activitiesaddop.py @@ -50,6 +50,10 @@ class CrmActivitiesAddRequestTypedDict(TypedDict): activity: ActivityInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class CrmActivitiesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_activitiesallop.py b/src/apideck_unify/models/crm_activitiesallop.py index 4b8183d4..b8c177de 100644 --- a/src/apideck_unify/models/crm_activitiesallop.py +++ b/src/apideck_unify/models/crm_activitiesallop.py @@ -49,6 +49,10 @@ class CrmActivitiesAllGlobals(BaseModel): class CrmActivitiesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class CrmActivitiesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class CrmActivitiesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_activitiesdeleteop.py b/src/apideck_unify/models/crm_activitiesdeleteop.py index 8057759d..e6d72ab9 100644 --- a/src/apideck_unify/models/crm_activitiesdeleteop.py +++ b/src/apideck_unify/models/crm_activitiesdeleteop.py @@ -48,6 +48,10 @@ class CrmActivitiesDeleteGlobals(BaseModel): class CrmActivitiesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class CrmActivitiesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_activitiesoneop.py b/src/apideck_unify/models/crm_activitiesoneop.py index becbe211..e1836c60 100644 --- a/src/apideck_unify/models/crm_activitiesoneop.py +++ b/src/apideck_unify/models/crm_activitiesoneop.py @@ -52,6 +52,10 @@ class CrmActivitiesOneGlobals(BaseModel): class CrmActivitiesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class CrmActivitiesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class CrmActivitiesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_activitiesupdateop.py b/src/apideck_unify/models/crm_activitiesupdateop.py index 2ceb422c..f2a3faac 100644 --- a/src/apideck_unify/models/crm_activitiesupdateop.py +++ b/src/apideck_unify/models/crm_activitiesupdateop.py @@ -51,6 +51,10 @@ class CrmActivitiesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" activity: ActivityInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class CrmActivitiesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_companiesaddop.py b/src/apideck_unify/models/crm_companiesaddop.py index efe7e482..e9ed3d96 100644 --- a/src/apideck_unify/models/crm_companiesaddop.py +++ b/src/apideck_unify/models/crm_companiesaddop.py @@ -47,6 +47,10 @@ class CrmCompaniesAddRequestTypedDict(TypedDict): company: CompanyInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class CrmCompaniesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_companiesallop.py b/src/apideck_unify/models/crm_companiesallop.py index ef8783f2..30944fd3 100644 --- a/src/apideck_unify/models/crm_companiesallop.py +++ b/src/apideck_unify/models/crm_companiesallop.py @@ -49,6 +49,10 @@ class CrmCompaniesAllGlobals(BaseModel): class CrmCompaniesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class CrmCompaniesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class CrmCompaniesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_companiesdeleteop.py b/src/apideck_unify/models/crm_companiesdeleteop.py index 0944cbb9..746bd754 100644 --- a/src/apideck_unify/models/crm_companiesdeleteop.py +++ b/src/apideck_unify/models/crm_companiesdeleteop.py @@ -47,6 +47,10 @@ class CrmCompaniesDeleteRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class CrmCompaniesDeleteRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_companiesoneop.py b/src/apideck_unify/models/crm_companiesoneop.py index d02e798f..fe10efc9 100644 --- a/src/apideck_unify/models/crm_companiesoneop.py +++ b/src/apideck_unify/models/crm_companiesoneop.py @@ -54,6 +54,10 @@ class CrmCompaniesOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class CrmCompaniesOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class CrmCompaniesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "fields"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_companiesupdateop.py b/src/apideck_unify/models/crm_companiesupdateop.py index 243d5576..086a0e1b 100644 --- a/src/apideck_unify/models/crm_companiesupdateop.py +++ b/src/apideck_unify/models/crm_companiesupdateop.py @@ -50,6 +50,10 @@ class CrmCompaniesUpdateRequestTypedDict(TypedDict): company: CompanyInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -71,6 +75,20 @@ class CrmCompaniesUpdateRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_contactsaddop.py b/src/apideck_unify/models/crm_contactsaddop.py index b5b7b754..796e29dd 100644 --- a/src/apideck_unify/models/crm_contactsaddop.py +++ b/src/apideck_unify/models/crm_contactsaddop.py @@ -47,6 +47,10 @@ class CrmContactsAddRequestTypedDict(TypedDict): contact: ContactInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class CrmContactsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_contactsallop.py b/src/apideck_unify/models/crm_contactsallop.py index cf518118..35d425e1 100644 --- a/src/apideck_unify/models/crm_contactsallop.py +++ b/src/apideck_unify/models/crm_contactsallop.py @@ -49,6 +49,10 @@ class CrmContactsAllGlobals(BaseModel): class CrmContactsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class CrmContactsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class CrmContactsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_contactsdeleteop.py b/src/apideck_unify/models/crm_contactsdeleteop.py index bb7f0e53..05f1c133 100644 --- a/src/apideck_unify/models/crm_contactsdeleteop.py +++ b/src/apideck_unify/models/crm_contactsdeleteop.py @@ -45,6 +45,10 @@ class CrmContactsDeleteGlobals(BaseModel): class CrmContactsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class CrmContactsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_contactsoneop.py b/src/apideck_unify/models/crm_contactsoneop.py index 57664151..23f4446b 100644 --- a/src/apideck_unify/models/crm_contactsoneop.py +++ b/src/apideck_unify/models/crm_contactsoneop.py @@ -53,6 +53,10 @@ class CrmContactsOneGlobals(BaseModel): class CrmContactsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class CrmContactsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -97,7 +115,14 @@ class CrmContactsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields", "filter"] + optional_fields = [ + "consumerId", + "appId", + "serviceId", + "raw", + "fields", + "filter", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_contactsupdateop.py b/src/apideck_unify/models/crm_contactsupdateop.py index a943fa89..b6d00100 100644 --- a/src/apideck_unify/models/crm_contactsupdateop.py +++ b/src/apideck_unify/models/crm_contactsupdateop.py @@ -48,6 +48,10 @@ class CrmContactsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" contact: ContactInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class CrmContactsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_leadsaddop.py b/src/apideck_unify/models/crm_leadsaddop.py index c363fc4d..e8c320d5 100644 --- a/src/apideck_unify/models/crm_leadsaddop.py +++ b/src/apideck_unify/models/crm_leadsaddop.py @@ -47,6 +47,10 @@ class CrmLeadsAddRequestTypedDict(TypedDict): lead: LeadInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -62,6 +66,20 @@ class CrmLeadsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_leadsallop.py b/src/apideck_unify/models/crm_leadsallop.py index 2a2c2125..8f1acb43 100644 --- a/src/apideck_unify/models/crm_leadsallop.py +++ b/src/apideck_unify/models/crm_leadsallop.py @@ -49,6 +49,10 @@ class CrmLeadsAllGlobals(BaseModel): class CrmLeadsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class CrmLeadsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class CrmLeadsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_leadsdeleteop.py b/src/apideck_unify/models/crm_leadsdeleteop.py index dd1064bb..682359d3 100644 --- a/src/apideck_unify/models/crm_leadsdeleteop.py +++ b/src/apideck_unify/models/crm_leadsdeleteop.py @@ -45,6 +45,10 @@ class CrmLeadsDeleteGlobals(BaseModel): class CrmLeadsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class CrmLeadsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_leadsoneop.py b/src/apideck_unify/models/crm_leadsoneop.py index bdb54563..40568931 100644 --- a/src/apideck_unify/models/crm_leadsoneop.py +++ b/src/apideck_unify/models/crm_leadsoneop.py @@ -52,6 +52,10 @@ class CrmLeadsOneGlobals(BaseModel): class CrmLeadsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class CrmLeadsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class CrmLeadsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_leadsupdateop.py b/src/apideck_unify/models/crm_leadsupdateop.py index fa54a39f..0e847405 100644 --- a/src/apideck_unify/models/crm_leadsupdateop.py +++ b/src/apideck_unify/models/crm_leadsupdateop.py @@ -48,6 +48,10 @@ class CrmLeadsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" lead: LeadInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -64,6 +68,20 @@ class CrmLeadsUpdateRequest(BaseModel): LeadInput, FieldMetadata(request=RequestMetadata(media_type="application/json")) ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_notesaddop.py b/src/apideck_unify/models/crm_notesaddop.py index 6cddacb3..2ed8923b 100644 --- a/src/apideck_unify/models/crm_notesaddop.py +++ b/src/apideck_unify/models/crm_notesaddop.py @@ -47,6 +47,10 @@ class CrmNotesAddRequestTypedDict(TypedDict): note: NoteInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -62,6 +66,20 @@ class CrmNotesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_notesallop.py b/src/apideck_unify/models/crm_notesallop.py index 8a344ed7..59f3e753 100644 --- a/src/apideck_unify/models/crm_notesallop.py +++ b/src/apideck_unify/models/crm_notesallop.py @@ -47,6 +47,10 @@ class CrmNotesAllGlobals(BaseModel): class CrmNotesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -66,6 +70,20 @@ class CrmNotesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,6 +119,8 @@ class CrmNotesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_notesdeleteop.py b/src/apideck_unify/models/crm_notesdeleteop.py index e92571e2..1005d412 100644 --- a/src/apideck_unify/models/crm_notesdeleteop.py +++ b/src/apideck_unify/models/crm_notesdeleteop.py @@ -45,6 +45,10 @@ class CrmNotesDeleteGlobals(BaseModel): class CrmNotesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class CrmNotesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_notesoneop.py b/src/apideck_unify/models/crm_notesoneop.py index 4fa9a8c7..6b0d80b3 100644 --- a/src/apideck_unify/models/crm_notesoneop.py +++ b/src/apideck_unify/models/crm_notesoneop.py @@ -52,6 +52,10 @@ class CrmNotesOneGlobals(BaseModel): class CrmNotesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class CrmNotesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class CrmNotesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_notesupdateop.py b/src/apideck_unify/models/crm_notesupdateop.py index 3687badb..821468f5 100644 --- a/src/apideck_unify/models/crm_notesupdateop.py +++ b/src/apideck_unify/models/crm_notesupdateop.py @@ -48,6 +48,10 @@ class CrmNotesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" note: NoteInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -64,6 +68,20 @@ class CrmNotesUpdateRequest(BaseModel): NoteInput, FieldMetadata(request=RequestMetadata(media_type="application/json")) ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_opportunitiesaddop.py b/src/apideck_unify/models/crm_opportunitiesaddop.py index 5d542340..7252dfb9 100644 --- a/src/apideck_unify/models/crm_opportunitiesaddop.py +++ b/src/apideck_unify/models/crm_opportunitiesaddop.py @@ -50,6 +50,10 @@ class CrmOpportunitiesAddRequestTypedDict(TypedDict): opportunity: OpportunityInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class CrmOpportunitiesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_opportunitiesallop.py b/src/apideck_unify/models/crm_opportunitiesallop.py index efe17d69..e2e084e6 100644 --- a/src/apideck_unify/models/crm_opportunitiesallop.py +++ b/src/apideck_unify/models/crm_opportunitiesallop.py @@ -52,6 +52,10 @@ class CrmOpportunitiesAllGlobals(BaseModel): class CrmOpportunitiesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class CrmOpportunitiesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class CrmOpportunitiesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_opportunitiesdeleteop.py b/src/apideck_unify/models/crm_opportunitiesdeleteop.py index 39dba810..9640a3e0 100644 --- a/src/apideck_unify/models/crm_opportunitiesdeleteop.py +++ b/src/apideck_unify/models/crm_opportunitiesdeleteop.py @@ -48,6 +48,10 @@ class CrmOpportunitiesDeleteGlobals(BaseModel): class CrmOpportunitiesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class CrmOpportunitiesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_opportunitiesoneop.py b/src/apideck_unify/models/crm_opportunitiesoneop.py index 12eed95a..5165caa1 100644 --- a/src/apideck_unify/models/crm_opportunitiesoneop.py +++ b/src/apideck_unify/models/crm_opportunitiesoneop.py @@ -55,6 +55,10 @@ class CrmOpportunitiesOneGlobals(BaseModel): class CrmOpportunitiesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class CrmOpportunitiesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class CrmOpportunitiesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_opportunitiesupdateop.py b/src/apideck_unify/models/crm_opportunitiesupdateop.py index 90767835..45cc35de 100644 --- a/src/apideck_unify/models/crm_opportunitiesupdateop.py +++ b/src/apideck_unify/models/crm_opportunitiesupdateop.py @@ -51,6 +51,10 @@ class CrmOpportunitiesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" opportunity: OpportunityInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class CrmOpportunitiesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_pipelinesallop.py b/src/apideck_unify/models/crm_pipelinesallop.py index af4c3701..adc1a7ab 100644 --- a/src/apideck_unify/models/crm_pipelinesallop.py +++ b/src/apideck_unify/models/crm_pipelinesallop.py @@ -47,6 +47,10 @@ class CrmPipelinesAllGlobals(BaseModel): class CrmPipelinesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -66,6 +70,20 @@ class CrmPipelinesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,6 +119,8 @@ class CrmPipelinesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_usersaddop.py b/src/apideck_unify/models/crm_usersaddop.py index f52e8367..a453ec16 100644 --- a/src/apideck_unify/models/crm_usersaddop.py +++ b/src/apideck_unify/models/crm_usersaddop.py @@ -47,6 +47,10 @@ class CrmUsersAddRequestTypedDict(TypedDict): user: UserInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -62,6 +66,20 @@ class CrmUsersAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_usersallop.py b/src/apideck_unify/models/crm_usersallop.py index 15e5fb5d..cfb920a4 100644 --- a/src/apideck_unify/models/crm_usersallop.py +++ b/src/apideck_unify/models/crm_usersallop.py @@ -47,6 +47,10 @@ class CrmUsersAllGlobals(BaseModel): class CrmUsersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -66,6 +70,20 @@ class CrmUsersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,6 +119,8 @@ class CrmUsersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/crm_usersdeleteop.py b/src/apideck_unify/models/crm_usersdeleteop.py index 3022ed6d..4384e2cc 100644 --- a/src/apideck_unify/models/crm_usersdeleteop.py +++ b/src/apideck_unify/models/crm_usersdeleteop.py @@ -45,6 +45,10 @@ class CrmUsersDeleteGlobals(BaseModel): class CrmUsersDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class CrmUsersDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/crm_usersoneop.py b/src/apideck_unify/models/crm_usersoneop.py index e835a14f..7fd3e6be 100644 --- a/src/apideck_unify/models/crm_usersoneop.py +++ b/src/apideck_unify/models/crm_usersoneop.py @@ -52,6 +52,10 @@ class CrmUsersOneGlobals(BaseModel): class CrmUsersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class CrmUsersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class CrmUsersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/crm_usersupdateop.py b/src/apideck_unify/models/crm_usersupdateop.py index 6ac36a1b..8f6887e0 100644 --- a/src/apideck_unify/models/crm_usersupdateop.py +++ b/src/apideck_unify/models/crm_usersupdateop.py @@ -48,6 +48,10 @@ class CrmUsersUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" user: UserInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -64,6 +68,20 @@ class CrmUsersUpdateRequest(BaseModel): UserInput, FieldMetadata(request=RequestMetadata(media_type="application/json")) ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/deleteaccountingdepartmentresponse.py b/src/apideck_unify/models/deleteaccountingdepartmentresponse.py index 9d73829d..05bc4760 100644 --- a/src/apideck_unify/models/deleteaccountingdepartmentresponse.py +++ b/src/apideck_unify/models/deleteaccountingdepartmentresponse.py @@ -20,6 +20,7 @@ class DeleteAccountingDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteAccountingDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteAccountingDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteaccountinglocationresponse.py b/src/apideck_unify/models/deleteaccountinglocationresponse.py index ce8b23a9..c66df9d2 100644 --- a/src/apideck_unify/models/deleteaccountinglocationresponse.py +++ b/src/apideck_unify/models/deleteaccountinglocationresponse.py @@ -20,6 +20,7 @@ class DeleteAccountingLocationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteAccountingLocationResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteAccountingLocationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteactivityresponse.py b/src/apideck_unify/models/deleteactivityresponse.py index f8152354..c5dd2d56 100644 --- a/src/apideck_unify/models/deleteactivityresponse.py +++ b/src/apideck_unify/models/deleteactivityresponse.py @@ -20,6 +20,7 @@ class DeleteActivityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteActivityResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteActivityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteapplicantresponse.py b/src/apideck_unify/models/deleteapplicantresponse.py index 3b796bf5..3d6961b4 100644 --- a/src/apideck_unify/models/deleteapplicantresponse.py +++ b/src/apideck_unify/models/deleteapplicantresponse.py @@ -20,6 +20,7 @@ class DeleteApplicantResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteApplicantResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteApplicantResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteapplicationresponse.py b/src/apideck_unify/models/deleteapplicationresponse.py index 4c15daab..81a2217f 100644 --- a/src/apideck_unify/models/deleteapplicationresponse.py +++ b/src/apideck_unify/models/deleteapplicationresponse.py @@ -20,6 +20,7 @@ class DeleteApplicationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteApplicationResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteApplicationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteattachmentresponse.py b/src/apideck_unify/models/deleteattachmentresponse.py index 8b9a747a..bdb322df 100644 --- a/src/apideck_unify/models/deleteattachmentresponse.py +++ b/src/apideck_unify/models/deleteattachmentresponse.py @@ -20,6 +20,7 @@ class DeleteAttachmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteAttachmentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteAttachmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletebillpaymentresponse.py b/src/apideck_unify/models/deletebillpaymentresponse.py index eeb8eabf..3f600f7b 100644 --- a/src/apideck_unify/models/deletebillpaymentresponse.py +++ b/src/apideck_unify/models/deletebillpaymentresponse.py @@ -20,6 +20,7 @@ class DeleteBillPaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteBillPaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteBillPaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletebillresponse.py b/src/apideck_unify/models/deletebillresponse.py index f967d54f..a1a67eab 100644 --- a/src/apideck_unify/models/deletebillresponse.py +++ b/src/apideck_unify/models/deletebillresponse.py @@ -20,6 +20,7 @@ class DeleteBillResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteBillResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteBillResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletecommentresponse.py b/src/apideck_unify/models/deletecommentresponse.py index 1c4648be..2d1b313e 100644 --- a/src/apideck_unify/models/deletecommentresponse.py +++ b/src/apideck_unify/models/deletecommentresponse.py @@ -20,6 +20,7 @@ class DeleteCommentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteCommentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteCommentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletecompanyresponse.py b/src/apideck_unify/models/deletecompanyresponse.py index a8408536..3c4c8df4 100644 --- a/src/apideck_unify/models/deletecompanyresponse.py +++ b/src/apideck_unify/models/deletecompanyresponse.py @@ -20,6 +20,7 @@ class DeleteCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletecontactresponse.py b/src/apideck_unify/models/deletecontactresponse.py index 65bbace7..ec61a9c0 100644 --- a/src/apideck_unify/models/deletecontactresponse.py +++ b/src/apideck_unify/models/deletecontactresponse.py @@ -20,6 +20,7 @@ class DeleteContactResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteContactResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteContactResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletecreditnoteresponse.py b/src/apideck_unify/models/deletecreditnoteresponse.py index 2858be76..5663c02b 100644 --- a/src/apideck_unify/models/deletecreditnoteresponse.py +++ b/src/apideck_unify/models/deletecreditnoteresponse.py @@ -20,6 +20,7 @@ class DeleteCreditNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteCreditNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteCreditNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletecustomerresponse.py b/src/apideck_unify/models/deletecustomerresponse.py index c041751c..1715d793 100644 --- a/src/apideck_unify/models/deletecustomerresponse.py +++ b/src/apideck_unify/models/deletecustomerresponse.py @@ -20,6 +20,7 @@ class DeleteCustomerResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteCustomerResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteCustomerResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletedepartmentresponse.py b/src/apideck_unify/models/deletedepartmentresponse.py index 8ca30c99..4d0713a2 100644 --- a/src/apideck_unify/models/deletedepartmentresponse.py +++ b/src/apideck_unify/models/deletedepartmentresponse.py @@ -20,6 +20,7 @@ class DeleteDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletedrivegroupresponse.py b/src/apideck_unify/models/deletedrivegroupresponse.py index e5d91e6a..e928f715 100644 --- a/src/apideck_unify/models/deletedrivegroupresponse.py +++ b/src/apideck_unify/models/deletedrivegroupresponse.py @@ -20,6 +20,7 @@ class DeleteDriveGroupResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteDriveGroupResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteDriveGroupResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletedriveresponse.py b/src/apideck_unify/models/deletedriveresponse.py index e142fc5e..4f9293df 100644 --- a/src/apideck_unify/models/deletedriveresponse.py +++ b/src/apideck_unify/models/deletedriveresponse.py @@ -20,6 +20,7 @@ class DeleteDriveResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteDriveResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteDriveResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteemployeeresponse.py b/src/apideck_unify/models/deleteemployeeresponse.py index b31ae78a..97fed0ee 100644 --- a/src/apideck_unify/models/deleteemployeeresponse.py +++ b/src/apideck_unify/models/deleteemployeeresponse.py @@ -20,6 +20,7 @@ class DeleteEmployeeResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteEmployeeResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteEmployeeResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteexpenseresponse.py b/src/apideck_unify/models/deleteexpenseresponse.py index 168bcf30..f30b294a 100644 --- a/src/apideck_unify/models/deleteexpenseresponse.py +++ b/src/apideck_unify/models/deleteexpenseresponse.py @@ -20,6 +20,7 @@ class DeleteExpenseResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteExpenseResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteExpenseResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletefileresponse.py b/src/apideck_unify/models/deletefileresponse.py index efb7a96c..b9871697 100644 --- a/src/apideck_unify/models/deletefileresponse.py +++ b/src/apideck_unify/models/deletefileresponse.py @@ -20,6 +20,7 @@ class DeleteFileResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteFileResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteFileResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletefolderresponse.py b/src/apideck_unify/models/deletefolderresponse.py index 77a1d5b9..75af80b1 100644 --- a/src/apideck_unify/models/deletefolderresponse.py +++ b/src/apideck_unify/models/deletefolderresponse.py @@ -20,6 +20,7 @@ class DeleteFolderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteFolderResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteFolderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletehriscompanyresponse.py b/src/apideck_unify/models/deletehriscompanyresponse.py index 85fd7868..a2818bbe 100644 --- a/src/apideck_unify/models/deletehriscompanyresponse.py +++ b/src/apideck_unify/models/deletehriscompanyresponse.py @@ -20,6 +20,7 @@ class DeleteHrisCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteHrisCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteHrisCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletejournalentryresponse.py b/src/apideck_unify/models/deletejournalentryresponse.py index 1fa86ff6..cc0b75c7 100644 --- a/src/apideck_unify/models/deletejournalentryresponse.py +++ b/src/apideck_unify/models/deletejournalentryresponse.py @@ -20,6 +20,7 @@ class DeleteJournalEntryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteJournalEntryResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteJournalEntryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteleadresponse.py b/src/apideck_unify/models/deleteleadresponse.py index 9e25a81e..d6eb9a8a 100644 --- a/src/apideck_unify/models/deleteleadresponse.py +++ b/src/apideck_unify/models/deleteleadresponse.py @@ -20,6 +20,7 @@ class DeleteLeadResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteLeadResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteLeadResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteledgeraccountresponse.py b/src/apideck_unify/models/deleteledgeraccountresponse.py index a2ca2c25..0c25bc7b 100644 --- a/src/apideck_unify/models/deleteledgeraccountresponse.py +++ b/src/apideck_unify/models/deleteledgeraccountresponse.py @@ -20,6 +20,7 @@ class DeleteLedgerAccountResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteLedgerAccountResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteLedgerAccountResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletemessageresponse.py b/src/apideck_unify/models/deletemessageresponse.py index c4c8396b..d520919d 100644 --- a/src/apideck_unify/models/deletemessageresponse.py +++ b/src/apideck_unify/models/deletemessageresponse.py @@ -20,6 +20,7 @@ class DeleteMessageResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteMessageResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteMessageResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletenoteresponse.py b/src/apideck_unify/models/deletenoteresponse.py index 49fd798b..6ffc8fec 100644 --- a/src/apideck_unify/models/deletenoteresponse.py +++ b/src/apideck_unify/models/deletenoteresponse.py @@ -20,6 +20,7 @@ class DeleteNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteopportunityresponse.py b/src/apideck_unify/models/deleteopportunityresponse.py index 2079cc74..d7ecde7b 100644 --- a/src/apideck_unify/models/deleteopportunityresponse.py +++ b/src/apideck_unify/models/deleteopportunityresponse.py @@ -20,6 +20,7 @@ class DeleteOpportunityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteOpportunityResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteOpportunityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletepaymentresponse.py b/src/apideck_unify/models/deletepaymentresponse.py index 6c0b592f..1bb7bddf 100644 --- a/src/apideck_unify/models/deletepaymentresponse.py +++ b/src/apideck_unify/models/deletepaymentresponse.py @@ -20,6 +20,7 @@ class DeletePaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeletePaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class DeletePaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletepurchaseorderresponse.py b/src/apideck_unify/models/deletepurchaseorderresponse.py index d1fc8391..e96d6f9c 100644 --- a/src/apideck_unify/models/deletepurchaseorderresponse.py +++ b/src/apideck_unify/models/deletepurchaseorderresponse.py @@ -20,6 +20,7 @@ class DeletePurchaseOrderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeletePurchaseOrderResponse(BaseModel): @@ -41,3 +42,4 @@ class DeletePurchaseOrderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletesharedlinkresponse.py b/src/apideck_unify/models/deletesharedlinkresponse.py index 215dfdcd..42d906b8 100644 --- a/src/apideck_unify/models/deletesharedlinkresponse.py +++ b/src/apideck_unify/models/deletesharedlinkresponse.py @@ -20,6 +20,7 @@ class DeleteSharedLinkResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteSharedLinkResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteSharedLinkResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletesubsidiaryresponse.py b/src/apideck_unify/models/deletesubsidiaryresponse.py index 2229b0e0..6948c995 100644 --- a/src/apideck_unify/models/deletesubsidiaryresponse.py +++ b/src/apideck_unify/models/deletesubsidiaryresponse.py @@ -20,6 +20,7 @@ class DeleteSubsidiaryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteSubsidiaryResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteSubsidiaryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletesupplierresponse.py b/src/apideck_unify/models/deletesupplierresponse.py index 0f258223..98716611 100644 --- a/src/apideck_unify/models/deletesupplierresponse.py +++ b/src/apideck_unify/models/deletesupplierresponse.py @@ -20,6 +20,7 @@ class DeleteSupplierResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteSupplierResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteSupplierResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletetaxrateresponse.py b/src/apideck_unify/models/deletetaxrateresponse.py index dcd1f8a8..0c7e53df 100644 --- a/src/apideck_unify/models/deletetaxrateresponse.py +++ b/src/apideck_unify/models/deletetaxrateresponse.py @@ -20,6 +20,7 @@ class DeleteTaxRateResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteTaxRateResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteTaxRateResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteticketresponse.py b/src/apideck_unify/models/deleteticketresponse.py index 3be1a5c5..803e215f 100644 --- a/src/apideck_unify/models/deleteticketresponse.py +++ b/src/apideck_unify/models/deleteticketresponse.py @@ -20,6 +20,7 @@ class DeleteTicketResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteTicketResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteTicketResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletetimeoffrequestresponse.py b/src/apideck_unify/models/deletetimeoffrequestresponse.py index 36634879..c6608cdc 100644 --- a/src/apideck_unify/models/deletetimeoffrequestresponse.py +++ b/src/apideck_unify/models/deletetimeoffrequestresponse.py @@ -20,6 +20,7 @@ class DeleteTimeOffRequestResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteTimeOffRequestResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteTimeOffRequestResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deletetrackingcategoryresponse.py b/src/apideck_unify/models/deletetrackingcategoryresponse.py index c154ebba..3f4b9cfd 100644 --- a/src/apideck_unify/models/deletetrackingcategoryresponse.py +++ b/src/apideck_unify/models/deletetrackingcategoryresponse.py @@ -20,6 +20,7 @@ class DeleteTrackingCategoryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteTrackingCategoryResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteTrackingCategoryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteuploadsessionresponse.py b/src/apideck_unify/models/deleteuploadsessionresponse.py index 8fea6658..4c3f7bf3 100644 --- a/src/apideck_unify/models/deleteuploadsessionresponse.py +++ b/src/apideck_unify/models/deleteuploadsessionresponse.py @@ -20,6 +20,7 @@ class DeleteUploadSessionResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteUploadSessionResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteUploadSessionResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/deleteuserresponse.py b/src/apideck_unify/models/deleteuserresponse.py index ff64f023..870c0196 100644 --- a/src/apideck_unify/models/deleteuserresponse.py +++ b/src/apideck_unify/models/deleteuserresponse.py @@ -20,6 +20,7 @@ class DeleteUserResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class DeleteUserResponse(BaseModel): @@ -41,3 +42,4 @@ class DeleteUserResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/ecommerce_customersallop.py b/src/apideck_unify/models/ecommerce_customersallop.py index 11959520..15921974 100644 --- a/src/apideck_unify/models/ecommerce_customersallop.py +++ b/src/apideck_unify/models/ecommerce_customersallop.py @@ -54,6 +54,10 @@ class EcommerceCustomersAllGlobals(BaseModel): class EcommerceCustomersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class EcommerceCustomersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -117,6 +135,8 @@ class EcommerceCustomersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/ecommerce_customersoneop.py b/src/apideck_unify/models/ecommerce_customersoneop.py index 48d6e25d..cc92f08e 100644 --- a/src/apideck_unify/models/ecommerce_customersoneop.py +++ b/src/apideck_unify/models/ecommerce_customersoneop.py @@ -55,6 +55,10 @@ class EcommerceCustomersOneGlobals(BaseModel): class EcommerceCustomersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class EcommerceCustomersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class EcommerceCustomersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/ecommerce_ordersallop.py b/src/apideck_unify/models/ecommerce_ordersallop.py index bf0cfc2d..7ab53247 100644 --- a/src/apideck_unify/models/ecommerce_ordersallop.py +++ b/src/apideck_unify/models/ecommerce_ordersallop.py @@ -52,6 +52,10 @@ class EcommerceOrdersAllGlobals(BaseModel): class EcommerceOrdersAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -75,6 +79,20 @@ class EcommerceOrdersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -123,6 +141,8 @@ class EcommerceOrdersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/ecommerce_ordersoneop.py b/src/apideck_unify/models/ecommerce_ordersoneop.py index 305f9032..1e4c77de 100644 --- a/src/apideck_unify/models/ecommerce_ordersoneop.py +++ b/src/apideck_unify/models/ecommerce_ordersoneop.py @@ -55,6 +55,10 @@ class EcommerceOrdersOneGlobals(BaseModel): class EcommerceOrdersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class EcommerceOrdersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class EcommerceOrdersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/ecommerce_productsallop.py b/src/apideck_unify/models/ecommerce_productsallop.py index 5342ae0f..6ca94392 100644 --- a/src/apideck_unify/models/ecommerce_productsallop.py +++ b/src/apideck_unify/models/ecommerce_productsallop.py @@ -47,6 +47,10 @@ class EcommerceProductsAllGlobals(BaseModel): class EcommerceProductsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -66,6 +70,20 @@ class EcommerceProductsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,6 +119,8 @@ class EcommerceProductsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/ecommerce_productsoneop.py b/src/apideck_unify/models/ecommerce_productsoneop.py index 82a93f7f..72c52456 100644 --- a/src/apideck_unify/models/ecommerce_productsoneop.py +++ b/src/apideck_unify/models/ecommerce_productsoneop.py @@ -52,6 +52,10 @@ class EcommerceProductsOneGlobals(BaseModel): class EcommerceProductsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class EcommerceProductsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class EcommerceProductsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/ecommerce_storesoneop.py b/src/apideck_unify/models/ecommerce_storesoneop.py index 8123167f..9278d4dd 100644 --- a/src/apideck_unify/models/ecommerce_storesoneop.py +++ b/src/apideck_unify/models/ecommerce_storesoneop.py @@ -45,6 +45,10 @@ class EcommerceStoresOneGlobals(BaseModel): class EcommerceStoresOneRequestTypedDict(TypedDict): + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -54,6 +58,20 @@ class EcommerceStoresOneRequestTypedDict(TypedDict): class EcommerceStoresOneRequest(BaseModel): + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -75,7 +93,7 @@ class EcommerceStoresOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_drivegroupsaddop.py b/src/apideck_unify/models/filestorage_drivegroupsaddop.py index ea8d8ffe..51320829 100644 --- a/src/apideck_unify/models/filestorage_drivegroupsaddop.py +++ b/src/apideck_unify/models/filestorage_drivegroupsaddop.py @@ -50,6 +50,10 @@ class FileStorageDriveGroupsAddRequestTypedDict(TypedDict): drive_group: DriveGroupInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class FileStorageDriveGroupsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_drivegroupsallop.py b/src/apideck_unify/models/filestorage_drivegroupsallop.py index 2d23c1f4..45f54e92 100644 --- a/src/apideck_unify/models/filestorage_drivegroupsallop.py +++ b/src/apideck_unify/models/filestorage_drivegroupsallop.py @@ -51,6 +51,10 @@ class FileStorageDriveGroupsAllGlobals(BaseModel): class FileStorageDriveGroupsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class FileStorageDriveGroupsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -114,6 +132,8 @@ class FileStorageDriveGroupsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/filestorage_drivegroupsdeleteop.py b/src/apideck_unify/models/filestorage_drivegroupsdeleteop.py index 9c47ffc3..0f2639ba 100644 --- a/src/apideck_unify/models/filestorage_drivegroupsdeleteop.py +++ b/src/apideck_unify/models/filestorage_drivegroupsdeleteop.py @@ -48,6 +48,10 @@ class FileStorageDriveGroupsDeleteGlobals(BaseModel): class FileStorageDriveGroupsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class FileStorageDriveGroupsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_drivegroupsoneop.py b/src/apideck_unify/models/filestorage_drivegroupsoneop.py index 1389efba..5aba7908 100644 --- a/src/apideck_unify/models/filestorage_drivegroupsoneop.py +++ b/src/apideck_unify/models/filestorage_drivegroupsoneop.py @@ -52,6 +52,10 @@ class FileStorageDriveGroupsOneGlobals(BaseModel): class FileStorageDriveGroupsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class FileStorageDriveGroupsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageDriveGroupsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_drivegroupsupdateop.py b/src/apideck_unify/models/filestorage_drivegroupsupdateop.py index 72e6830f..8950c8b0 100644 --- a/src/apideck_unify/models/filestorage_drivegroupsupdateop.py +++ b/src/apideck_unify/models/filestorage_drivegroupsupdateop.py @@ -51,6 +51,10 @@ class FileStorageDriveGroupsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" drive_group: DriveGroupInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class FileStorageDriveGroupsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_drivesaddop.py b/src/apideck_unify/models/filestorage_drivesaddop.py index 7d8ddd9e..e31cc069 100644 --- a/src/apideck_unify/models/filestorage_drivesaddop.py +++ b/src/apideck_unify/models/filestorage_drivesaddop.py @@ -47,6 +47,10 @@ class FileStorageDrivesAddRequestTypedDict(TypedDict): drive: DriveInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class FileStorageDrivesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_drivesallop.py b/src/apideck_unify/models/filestorage_drivesallop.py index e373c6a6..c005a2a6 100644 --- a/src/apideck_unify/models/filestorage_drivesallop.py +++ b/src/apideck_unify/models/filestorage_drivesallop.py @@ -48,6 +48,10 @@ class FileStorageDrivesAllGlobals(BaseModel): class FileStorageDrivesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -67,6 +71,20 @@ class FileStorageDrivesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -101,7 +119,16 @@ class FileStorageDrivesAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "filter", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "filter", + "fields", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_drivesdeleteop.py b/src/apideck_unify/models/filestorage_drivesdeleteop.py index 032d8247..37d36791 100644 --- a/src/apideck_unify/models/filestorage_drivesdeleteop.py +++ b/src/apideck_unify/models/filestorage_drivesdeleteop.py @@ -45,6 +45,10 @@ class FileStorageDrivesDeleteGlobals(BaseModel): class FileStorageDrivesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class FileStorageDrivesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_drivesoneop.py b/src/apideck_unify/models/filestorage_drivesoneop.py index c545cd6e..0229fb72 100644 --- a/src/apideck_unify/models/filestorage_drivesoneop.py +++ b/src/apideck_unify/models/filestorage_drivesoneop.py @@ -52,6 +52,10 @@ class FileStorageDrivesOneGlobals(BaseModel): class FileStorageDrivesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class FileStorageDrivesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageDrivesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_drivesupdateop.py b/src/apideck_unify/models/filestorage_drivesupdateop.py index 519db177..f9d1b8a6 100644 --- a/src/apideck_unify/models/filestorage_drivesupdateop.py +++ b/src/apideck_unify/models/filestorage_drivesupdateop.py @@ -48,6 +48,10 @@ class FileStorageDrivesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" drive: DriveInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class FileStorageDrivesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_filesallop.py b/src/apideck_unify/models/filestorage_filesallop.py index 023a0d31..de1a43fc 100644 --- a/src/apideck_unify/models/filestorage_filesallop.py +++ b/src/apideck_unify/models/filestorage_filesallop.py @@ -49,6 +49,10 @@ class FileStorageFilesAllGlobals(BaseModel): class FileStorageFilesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class FileStorageFilesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class FileStorageFilesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/filestorage_filesdeleteop.py b/src/apideck_unify/models/filestorage_filesdeleteop.py index 3d297206..f0f8bf7f 100644 --- a/src/apideck_unify/models/filestorage_filesdeleteop.py +++ b/src/apideck_unify/models/filestorage_filesdeleteop.py @@ -45,6 +45,10 @@ class FileStorageFilesDeleteGlobals(BaseModel): class FileStorageFilesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class FileStorageFilesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_filesdownloadop.py b/src/apideck_unify/models/filestorage_filesdownloadop.py index 634724c2..697d2513 100644 --- a/src/apideck_unify/models/filestorage_filesdownloadop.py +++ b/src/apideck_unify/models/filestorage_filesdownloadop.py @@ -52,6 +52,10 @@ class FileStorageFilesDownloadGlobals(BaseModel): class FileStorageFilesDownloadRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -64,6 +68,20 @@ class FileStorageFilesDownloadRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -79,7 +97,7 @@ class FileStorageFilesDownloadRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_filesexportop.py b/src/apideck_unify/models/filestorage_filesexportop.py index 9577cadd..c66fce92 100644 --- a/src/apideck_unify/models/filestorage_filesexportop.py +++ b/src/apideck_unify/models/filestorage_filesexportop.py @@ -54,6 +54,10 @@ class FileStorageFilesExportRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" file_format: str r"""File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -71,6 +75,20 @@ class FileStorageFilesExportRequest(BaseModel): ] r"""File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -86,7 +104,7 @@ class FileStorageFilesExportRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_filesoneop.py b/src/apideck_unify/models/filestorage_filesoneop.py index cd3ab091..d11b3914 100644 --- a/src/apideck_unify/models/filestorage_filesoneop.py +++ b/src/apideck_unify/models/filestorage_filesoneop.py @@ -52,6 +52,10 @@ class FileStorageFilesOneGlobals(BaseModel): class FileStorageFilesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class FileStorageFilesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageFilesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_filessearchop.py b/src/apideck_unify/models/filestorage_filessearchop.py index 235b34d6..5c55e6c6 100644 --- a/src/apideck_unify/models/filestorage_filessearchop.py +++ b/src/apideck_unify/models/filestorage_filessearchop.py @@ -53,6 +53,10 @@ class FileStorageFilesSearchGlobals(BaseModel): class FileStorageFilesSearchRequestTypedDict(TypedDict): files_search: FilesSearchTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" pass_through_param: NotRequired[Dict[str, Any]] @@ -73,6 +77,20 @@ class FileStorageFilesSearchRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -115,6 +133,8 @@ class FileStorageFilesSearchRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "consumerId", + "appId", "serviceId", "pass_through_param", "fields", diff --git a/src/apideck_unify/models/filestorage_filesupdateop.py b/src/apideck_unify/models/filestorage_filesupdateop.py index 5ff98050..c1d2dbcf 100644 --- a/src/apideck_unify/models/filestorage_filesupdateop.py +++ b/src/apideck_unify/models/filestorage_filesupdateop.py @@ -48,6 +48,10 @@ class FileStorageFilesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" update_file_request: UpdateFileRequestTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class FileStorageFilesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_foldersaddop.py b/src/apideck_unify/models/filestorage_foldersaddop.py index 99a1db62..52580660 100644 --- a/src/apideck_unify/models/filestorage_foldersaddop.py +++ b/src/apideck_unify/models/filestorage_foldersaddop.py @@ -54,6 +54,10 @@ class FileStorageFoldersAddRequestTypedDict(TypedDict): create_folder_request: CreateFolderRequestTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class FileStorageFoldersAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageFoldersAddRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "fields"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_folderscopyop.py b/src/apideck_unify/models/filestorage_folderscopyop.py index e6fbea77..40aeab79 100644 --- a/src/apideck_unify/models/filestorage_folderscopyop.py +++ b/src/apideck_unify/models/filestorage_folderscopyop.py @@ -55,6 +55,10 @@ class FileStorageFoldersCopyRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" copy_folder_request: CopyFolderRequestTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -74,6 +78,20 @@ class FileStorageFoldersCopyRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -95,7 +113,7 @@ class FileStorageFoldersCopyRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_foldersdeleteop.py b/src/apideck_unify/models/filestorage_foldersdeleteop.py index 8a681f94..de3495af 100644 --- a/src/apideck_unify/models/filestorage_foldersdeleteop.py +++ b/src/apideck_unify/models/filestorage_foldersdeleteop.py @@ -45,6 +45,10 @@ class FileStorageFoldersDeleteGlobals(BaseModel): class FileStorageFoldersDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class FileStorageFoldersDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_foldersoneop.py b/src/apideck_unify/models/filestorage_foldersoneop.py index 4cf5055b..6802745a 100644 --- a/src/apideck_unify/models/filestorage_foldersoneop.py +++ b/src/apideck_unify/models/filestorage_foldersoneop.py @@ -52,6 +52,10 @@ class FileStorageFoldersOneGlobals(BaseModel): class FileStorageFoldersOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class FileStorageFoldersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageFoldersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_foldersupdateop.py b/src/apideck_unify/models/filestorage_foldersupdateop.py index 8213bbf3..dea25946 100644 --- a/src/apideck_unify/models/filestorage_foldersupdateop.py +++ b/src/apideck_unify/models/filestorage_foldersupdateop.py @@ -48,6 +48,10 @@ class FileStorageFoldersUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" update_folder_request: UpdateFolderRequestTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class FileStorageFoldersUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_sharedlinksaddop.py b/src/apideck_unify/models/filestorage_sharedlinksaddop.py index fd6c23f9..f582890d 100644 --- a/src/apideck_unify/models/filestorage_sharedlinksaddop.py +++ b/src/apideck_unify/models/filestorage_sharedlinksaddop.py @@ -50,6 +50,10 @@ class FileStorageSharedLinksAddRequestTypedDict(TypedDict): shared_link: SharedLinkInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class FileStorageSharedLinksAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_sharedlinksallop.py b/src/apideck_unify/models/filestorage_sharedlinksallop.py index f59ff984..5587348c 100644 --- a/src/apideck_unify/models/filestorage_sharedlinksallop.py +++ b/src/apideck_unify/models/filestorage_sharedlinksallop.py @@ -50,6 +50,10 @@ class FileStorageSharedLinksAllGlobals(BaseModel): class FileStorageSharedLinksAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class FileStorageSharedLinksAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -104,6 +122,8 @@ class FileStorageSharedLinksAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/filestorage_sharedlinksdeleteop.py b/src/apideck_unify/models/filestorage_sharedlinksdeleteop.py index 0939e206..0c00656d 100644 --- a/src/apideck_unify/models/filestorage_sharedlinksdeleteop.py +++ b/src/apideck_unify/models/filestorage_sharedlinksdeleteop.py @@ -48,6 +48,10 @@ class FileStorageSharedLinksDeleteGlobals(BaseModel): class FileStorageSharedLinksDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class FileStorageSharedLinksDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_sharedlinksoneop.py b/src/apideck_unify/models/filestorage_sharedlinksoneop.py index 8d478804..0ca21976 100644 --- a/src/apideck_unify/models/filestorage_sharedlinksoneop.py +++ b/src/apideck_unify/models/filestorage_sharedlinksoneop.py @@ -52,6 +52,10 @@ class FileStorageSharedLinksOneGlobals(BaseModel): class FileStorageSharedLinksOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class FileStorageSharedLinksOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class FileStorageSharedLinksOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/filestorage_sharedlinksupdateop.py b/src/apideck_unify/models/filestorage_sharedlinksupdateop.py index 3559a305..6d64f09a 100644 --- a/src/apideck_unify/models/filestorage_sharedlinksupdateop.py +++ b/src/apideck_unify/models/filestorage_sharedlinksupdateop.py @@ -51,6 +51,10 @@ class FileStorageSharedLinksUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" shared_link: SharedLinkInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class FileStorageSharedLinksUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_uploadsessionsaddop.py b/src/apideck_unify/models/filestorage_uploadsessionsaddop.py index 0739157e..dd60acd1 100644 --- a/src/apideck_unify/models/filestorage_uploadsessionsaddop.py +++ b/src/apideck_unify/models/filestorage_uploadsessionsaddop.py @@ -57,6 +57,10 @@ class FileStorageUploadSessionsAddRequestTypedDict(TypedDict): create_upload_session_request: CreateUploadSessionRequestTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -73,6 +77,20 @@ class FileStorageUploadSessionsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_uploadsessionsdeleteop.py b/src/apideck_unify/models/filestorage_uploadsessionsdeleteop.py index 98f38fde..a6598dba 100644 --- a/src/apideck_unify/models/filestorage_uploadsessionsdeleteop.py +++ b/src/apideck_unify/models/filestorage_uploadsessionsdeleteop.py @@ -48,6 +48,10 @@ class FileStorageUploadSessionsDeleteGlobals(BaseModel): class FileStorageUploadSessionsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class FileStorageUploadSessionsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_uploadsessionsfinishop.py b/src/apideck_unify/models/filestorage_uploadsessionsfinishop.py index a02de819..cbf7762d 100644 --- a/src/apideck_unify/models/filestorage_uploadsessionsfinishop.py +++ b/src/apideck_unify/models/filestorage_uploadsessionsfinishop.py @@ -60,6 +60,10 @@ class FileStorageUploadSessionsFinishRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" digest: NotRequired[str] @@ -79,6 +83,20 @@ class FileStorageUploadSessionsFinishRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/filestorage_uploadsessionsoneop.py b/src/apideck_unify/models/filestorage_uploadsessionsoneop.py index ccc98628..fb59246a 100644 --- a/src/apideck_unify/models/filestorage_uploadsessionsoneop.py +++ b/src/apideck_unify/models/filestorage_uploadsessionsoneop.py @@ -59,6 +59,10 @@ class FileStorageUploadSessionsOneGlobals(BaseModel): class FileStorageUploadSessionsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -73,6 +77,20 @@ class FileStorageUploadSessionsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -94,7 +112,7 @@ class FileStorageUploadSessionsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_companiesaddop.py b/src/apideck_unify/models/hris_companiesaddop.py index 6fbe6de3..3426ff81 100644 --- a/src/apideck_unify/models/hris_companiesaddop.py +++ b/src/apideck_unify/models/hris_companiesaddop.py @@ -50,6 +50,10 @@ class HrisCompaniesAddRequestTypedDict(TypedDict): hris_company: HrisCompanyInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class HrisCompaniesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_companiesallop.py b/src/apideck_unify/models/hris_companiesallop.py index 693aab44..cf460ff1 100644 --- a/src/apideck_unify/models/hris_companiesallop.py +++ b/src/apideck_unify/models/hris_companiesallop.py @@ -50,6 +50,10 @@ class HrisCompaniesAllGlobals(BaseModel): class HrisCompaniesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class HrisCompaniesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -104,6 +122,8 @@ class HrisCompaniesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/hris_companiesdeleteop.py b/src/apideck_unify/models/hris_companiesdeleteop.py index 826bad81..d6c9e5bb 100644 --- a/src/apideck_unify/models/hris_companiesdeleteop.py +++ b/src/apideck_unify/models/hris_companiesdeleteop.py @@ -48,6 +48,10 @@ class HrisCompaniesDeleteGlobals(BaseModel): class HrisCompaniesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class HrisCompaniesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_companiesoneop.py b/src/apideck_unify/models/hris_companiesoneop.py index bf606c2a..6d36df5e 100644 --- a/src/apideck_unify/models/hris_companiesoneop.py +++ b/src/apideck_unify/models/hris_companiesoneop.py @@ -55,6 +55,10 @@ class HrisCompaniesOneGlobals(BaseModel): class HrisCompaniesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -69,6 +73,20 @@ class HrisCompaniesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -90,7 +108,7 @@ class HrisCompaniesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_companiesupdateop.py b/src/apideck_unify/models/hris_companiesupdateop.py index 92879617..78377e1b 100644 --- a/src/apideck_unify/models/hris_companiesupdateop.py +++ b/src/apideck_unify/models/hris_companiesupdateop.py @@ -51,6 +51,10 @@ class HrisCompaniesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" hris_company: HrisCompanyInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class HrisCompaniesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_departmentsaddop.py b/src/apideck_unify/models/hris_departmentsaddop.py index c78793c2..ff7c6ffb 100644 --- a/src/apideck_unify/models/hris_departmentsaddop.py +++ b/src/apideck_unify/models/hris_departmentsaddop.py @@ -50,6 +50,10 @@ class HrisDepartmentsAddRequestTypedDict(TypedDict): department: DepartmentInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class HrisDepartmentsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_departmentsallop.py b/src/apideck_unify/models/hris_departmentsallop.py index 05afd0b4..811ea77b 100644 --- a/src/apideck_unify/models/hris_departmentsallop.py +++ b/src/apideck_unify/models/hris_departmentsallop.py @@ -50,6 +50,10 @@ class HrisDepartmentsAllGlobals(BaseModel): class HrisDepartmentsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -69,6 +73,20 @@ class HrisDepartmentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -104,6 +122,8 @@ class HrisDepartmentsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/hris_departmentsdeleteop.py b/src/apideck_unify/models/hris_departmentsdeleteop.py index 77eacfc8..26e668cd 100644 --- a/src/apideck_unify/models/hris_departmentsdeleteop.py +++ b/src/apideck_unify/models/hris_departmentsdeleteop.py @@ -48,6 +48,10 @@ class HrisDepartmentsDeleteGlobals(BaseModel): class HrisDepartmentsDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class HrisDepartmentsDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_departmentsoneop.py b/src/apideck_unify/models/hris_departmentsoneop.py index 156f2a7c..481a0198 100644 --- a/src/apideck_unify/models/hris_departmentsoneop.py +++ b/src/apideck_unify/models/hris_departmentsoneop.py @@ -52,6 +52,10 @@ class HrisDepartmentsOneGlobals(BaseModel): class HrisDepartmentsOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class HrisDepartmentsOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class HrisDepartmentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_departmentsupdateop.py b/src/apideck_unify/models/hris_departmentsupdateop.py index e62a5281..c7279da4 100644 --- a/src/apideck_unify/models/hris_departmentsupdateop.py +++ b/src/apideck_unify/models/hris_departmentsupdateop.py @@ -51,6 +51,10 @@ class HrisDepartmentsUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" department: DepartmentInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -68,6 +72,20 @@ class HrisDepartmentsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_employeepayrollsallop.py b/src/apideck_unify/models/hris_employeepayrollsallop.py index b03bcd30..0bb9126a 100644 --- a/src/apideck_unify/models/hris_employeepayrollsallop.py +++ b/src/apideck_unify/models/hris_employeepayrollsallop.py @@ -58,6 +58,10 @@ class HrisEmployeePayrollsAllRequestTypedDict(TypedDict): r"""ID of the employee you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" filter_: NotRequired[PayrollsFilterTypedDict] @@ -80,6 +84,20 @@ class HrisEmployeePayrollsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -108,7 +126,15 @@ class HrisEmployeePayrollsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "filter", "pass_through", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "filter", + "pass_through", + "fields", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_employeepayrollsoneop.py b/src/apideck_unify/models/hris_employeepayrollsoneop.py index bc00ba01..f003e81e 100644 --- a/src/apideck_unify/models/hris_employeepayrollsoneop.py +++ b/src/apideck_unify/models/hris_employeepayrollsoneop.py @@ -59,6 +59,10 @@ class HrisEmployeePayrollsOneRequestTypedDict(TypedDict): r"""ID of the employee you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -82,6 +86,20 @@ class HrisEmployeePayrollsOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -97,7 +115,7 @@ class HrisEmployeePayrollsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "fields"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_employeesaddop.py b/src/apideck_unify/models/hris_employeesaddop.py index 4c44e931..004e4a32 100644 --- a/src/apideck_unify/models/hris_employeesaddop.py +++ b/src/apideck_unify/models/hris_employeesaddop.py @@ -50,6 +50,10 @@ class HrisEmployeesAddRequestTypedDict(TypedDict): employee: EmployeeInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class HrisEmployeesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_employeesallop.py b/src/apideck_unify/models/hris_employeesallop.py index b0e0d368..6a1b051b 100644 --- a/src/apideck_unify/models/hris_employeesallop.py +++ b/src/apideck_unify/models/hris_employeesallop.py @@ -49,6 +49,10 @@ class HrisEmployeesAllGlobals(BaseModel): class HrisEmployeesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class HrisEmployeesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -120,6 +138,8 @@ class HrisEmployeesAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/hris_employeeschedulesallop.py b/src/apideck_unify/models/hris_employeeschedulesallop.py index 28b72d49..cb0db21b 100644 --- a/src/apideck_unify/models/hris_employeeschedulesallop.py +++ b/src/apideck_unify/models/hris_employeeschedulesallop.py @@ -57,6 +57,10 @@ class HrisEmployeeSchedulesAllRequestTypedDict(TypedDict): r"""ID of the employee you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" pass_through: NotRequired[Dict[str, Any]] @@ -77,6 +81,20 @@ class HrisEmployeeSchedulesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -98,7 +116,14 @@ class HrisEmployeeSchedulesAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "pass_through", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "pass_through", + "fields", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_employeesdeleteop.py b/src/apideck_unify/models/hris_employeesdeleteop.py index b40b64de..73001f69 100644 --- a/src/apideck_unify/models/hris_employeesdeleteop.py +++ b/src/apideck_unify/models/hris_employeesdeleteop.py @@ -48,6 +48,10 @@ class HrisEmployeesDeleteGlobals(BaseModel): class HrisEmployeesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -60,6 +64,20 @@ class HrisEmployeesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_employeesoneop.py b/src/apideck_unify/models/hris_employeesoneop.py index 2cf8409c..6f44e841 100644 --- a/src/apideck_unify/models/hris_employeesoneop.py +++ b/src/apideck_unify/models/hris_employeesoneop.py @@ -53,6 +53,10 @@ class HrisEmployeesOneGlobals(BaseModel): class HrisEmployeesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -71,6 +75,20 @@ class HrisEmployeesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -105,7 +123,15 @@ class HrisEmployeesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields", "filter", "pass_through"] + optional_fields = [ + "consumerId", + "appId", + "serviceId", + "raw", + "fields", + "filter", + "pass_through", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_employeesupdateop.py b/src/apideck_unify/models/hris_employeesupdateop.py index 6d7f0a87..8e3bfca7 100644 --- a/src/apideck_unify/models/hris_employeesupdateop.py +++ b/src/apideck_unify/models/hris_employeesupdateop.py @@ -51,6 +51,10 @@ class HrisEmployeesUpdateRequestTypedDict(TypedDict): id_param: str r"""ID of the record you are acting upon.""" employee: EmployeeInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -70,6 +74,20 @@ class HrisEmployeesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_payrollsallop.py b/src/apideck_unify/models/hris_payrollsallop.py index 09b2b660..7a85de79 100644 --- a/src/apideck_unify/models/hris_payrollsallop.py +++ b/src/apideck_unify/models/hris_payrollsallop.py @@ -48,6 +48,10 @@ class HrisPayrollsAllGlobals(BaseModel): class HrisPayrollsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" filter_: NotRequired[PayrollsFilterTypedDict] @@ -65,6 +69,20 @@ class HrisPayrollsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -93,7 +111,15 @@ class HrisPayrollsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "filter", "pass_through", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "filter", + "pass_through", + "fields", + ] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_payrollsoneop.py b/src/apideck_unify/models/hris_payrollsoneop.py index f7688457..13fe3762 100644 --- a/src/apideck_unify/models/hris_payrollsoneop.py +++ b/src/apideck_unify/models/hris_payrollsoneop.py @@ -54,6 +54,10 @@ class HrisPayrollsOneRequestTypedDict(TypedDict): r"""ID of the payroll you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" fields: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class HrisPayrollsOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class HrisPayrollsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "fields"] + optional_fields = ["raw", "consumerId", "appId", "serviceId", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_timeoffrequestsaddop.py b/src/apideck_unify/models/hris_timeoffrequestsaddop.py index a11729ed..34b1e14d 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsaddop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsaddop.py @@ -50,6 +50,10 @@ class HrisTimeOffRequestsAddRequestTypedDict(TypedDict): time_off_request: TimeOffRequestInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -66,6 +70,20 @@ class HrisTimeOffRequestsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_timeoffrequestsallop.py b/src/apideck_unify/models/hris_timeoffrequestsallop.py index b5fcd46b..1190f436 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsallop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsallop.py @@ -51,6 +51,10 @@ class HrisTimeOffRequestsAllGlobals(BaseModel): class HrisTimeOffRequestsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class HrisTimeOffRequestsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -114,6 +132,8 @@ class HrisTimeOffRequestsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/hris_timeoffrequestsdeleteop.py b/src/apideck_unify/models/hris_timeoffrequestsdeleteop.py index bd77769c..ad23051f 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsdeleteop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsdeleteop.py @@ -50,6 +50,10 @@ class HrisTimeOffRequestsDeleteRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" employee_id: str r"""ID of the employee you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -67,6 +71,20 @@ class HrisTimeOffRequestsDeleteRequest(BaseModel): ] r"""ID of the employee you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/hris_timeoffrequestsoneop.py b/src/apideck_unify/models/hris_timeoffrequestsoneop.py index f8746770..8764a166 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsoneop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsoneop.py @@ -57,6 +57,10 @@ class HrisTimeOffRequestsOneRequestTypedDict(TypedDict): r"""ID of the record you are acting upon.""" employee_id: str r"""ID of the employee you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -76,6 +80,20 @@ class HrisTimeOffRequestsOneRequest(BaseModel): ] r"""ID of the employee you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -97,7 +115,7 @@ class HrisTimeOffRequestsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/hris_timeoffrequestsupdateop.py b/src/apideck_unify/models/hris_timeoffrequestsupdateop.py index 2b31144f..4351afa0 100644 --- a/src/apideck_unify/models/hris_timeoffrequestsupdateop.py +++ b/src/apideck_unify/models/hris_timeoffrequestsupdateop.py @@ -53,6 +53,10 @@ class HrisTimeOffRequestsUpdateRequestTypedDict(TypedDict): employee_id_param: str r"""ID of the employee you are acting upon.""" time_off_request: TimeOffRequestInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -77,6 +81,20 @@ class HrisTimeOffRequestsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionsallop.py b/src/apideck_unify/models/issuetracking_collectionsallop.py index 3bcb24f3..37885606 100644 --- a/src/apideck_unify/models/issuetracking_collectionsallop.py +++ b/src/apideck_unify/models/issuetracking_collectionsallop.py @@ -51,6 +51,10 @@ class IssueTrackingCollectionsAllGlobals(BaseModel): class IssueTrackingCollectionsAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -72,6 +76,20 @@ class IssueTrackingCollectionsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -113,6 +131,8 @@ class IssueTrackingCollectionsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/issuetracking_collectionsoneop.py b/src/apideck_unify/models/issuetracking_collectionsoneop.py index d9026d71..96f8dc1e 100644 --- a/src/apideck_unify/models/issuetracking_collectionsoneop.py +++ b/src/apideck_unify/models/issuetracking_collectionsoneop.py @@ -52,6 +52,10 @@ class IssueTrackingCollectionsOneGlobals(BaseModel): class IssueTrackingCollectionsOneRequestTypedDict(TypedDict): collection_id: str r"""The collection ID""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class IssueTrackingCollectionsOneRequest(BaseModel): ] r"""The collection ID""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class IssueTrackingCollectionsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/issuetracking_collectiontagsallop.py b/src/apideck_unify/models/issuetracking_collectiontagsallop.py index cd591bea..e1e8a1df 100644 --- a/src/apideck_unify/models/issuetracking_collectiontagsallop.py +++ b/src/apideck_unify/models/issuetracking_collectiontagsallop.py @@ -57,6 +57,10 @@ class IssueTrackingCollectionTagsAllRequestTypedDict(TypedDict): r"""The collection ID""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -81,6 +85,20 @@ class IssueTrackingCollectionTagsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -116,6 +134,8 @@ class IssueTrackingCollectionTagsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/issuetracking_collectionticketcommentsaddop.py b/src/apideck_unify/models/issuetracking_collectionticketcommentsaddop.py index 02709d9c..c9b6d6e9 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketcommentsaddop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketcommentsaddop.py @@ -55,6 +55,10 @@ class IssueTrackingCollectionTicketCommentsAddRequestTypedDict(TypedDict): collection_ticket_comment: CollectionTicketCommentInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -81,6 +85,20 @@ class IssueTrackingCollectionTicketCommentsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionticketcommentsallop.py b/src/apideck_unify/models/issuetracking_collectionticketcommentsallop.py index 38f9306c..98b8dd78 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketcommentsallop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketcommentsallop.py @@ -57,6 +57,10 @@ class IssueTrackingCollectionTicketCommentsAllRequestTypedDict(TypedDict): r"""ID of the ticket you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -88,6 +92,20 @@ class IssueTrackingCollectionTicketCommentsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -129,6 +147,8 @@ class IssueTrackingCollectionTicketCommentsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/issuetracking_collectionticketcommentsdeleteop.py b/src/apideck_unify/models/issuetracking_collectionticketcommentsdeleteop.py index b73209c5..7e093ccd 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketcommentsdeleteop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketcommentsdeleteop.py @@ -49,6 +49,10 @@ class IssueTrackingCollectionTicketCommentsDeleteRequestTypedDict(TypedDict): r"""The collection ID""" ticket_id: str r"""ID of the ticket you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -71,6 +75,20 @@ class IssueTrackingCollectionTicketCommentsDeleteRequest(BaseModel): ] r"""ID of the ticket you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionticketcommentsoneop.py b/src/apideck_unify/models/issuetracking_collectionticketcommentsoneop.py index 363666e3..e586fc5d 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketcommentsoneop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketcommentsoneop.py @@ -58,6 +58,10 @@ class IssueTrackingCollectionTicketCommentsOneRequestTypedDict(TypedDict): r"""ID of the ticket you are acting upon.""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -90,6 +94,20 @@ class IssueTrackingCollectionTicketCommentsOneRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -117,7 +135,15 @@ class IssueTrackingCollectionTicketCommentsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/issuetracking_collectionticketcommentsupdateop.py b/src/apideck_unify/models/issuetracking_collectionticketcommentsupdateop.py index f6e6a799..8ed0d8ac 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketcommentsupdateop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketcommentsupdateop.py @@ -55,6 +55,10 @@ class IssueTrackingCollectionTicketCommentsUpdateRequestTypedDict(TypedDict): ticket_id: str r"""ID of the ticket you are acting upon.""" collection_ticket_comment: CollectionTicketCommentInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -82,6 +86,20 @@ class IssueTrackingCollectionTicketCommentsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionticketsaddop.py b/src/apideck_unify/models/issuetracking_collectionticketsaddop.py index 28084de1..e29d391a 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsaddop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsaddop.py @@ -50,6 +50,10 @@ class IssueTrackingCollectionTicketsAddRequestTypedDict(TypedDict): ticket: TicketInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -71,6 +75,20 @@ class IssueTrackingCollectionTicketsAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionticketsallop.py b/src/apideck_unify/models/issuetracking_collectionticketsallop.py index 27913b7e..014de3f7 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsallop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsallop.py @@ -56,6 +56,10 @@ class IssueTrackingCollectionTicketsAllRequestTypedDict(TypedDict): r"""The collection ID""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -84,6 +88,20 @@ class IssueTrackingCollectionTicketsAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -132,6 +150,8 @@ class IssueTrackingCollectionTicketsAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/issuetracking_collectionticketsdeleteop.py b/src/apideck_unify/models/issuetracking_collectionticketsdeleteop.py index f6b1abcc..f6946bc7 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsdeleteop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsdeleteop.py @@ -47,6 +47,10 @@ class IssueTrackingCollectionTicketsDeleteRequestTypedDict(TypedDict): r"""ID of the ticket you are acting upon.""" collection_id: str r"""The collection ID""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -64,6 +68,20 @@ class IssueTrackingCollectionTicketsDeleteRequest(BaseModel): ] r"""The collection ID""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionticketsoneop.py b/src/apideck_unify/models/issuetracking_collectionticketsoneop.py index ff32702f..9d4c0ec1 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsoneop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsoneop.py @@ -54,6 +54,10 @@ class IssueTrackingCollectionTicketsOneRequestTypedDict(TypedDict): r"""ID of the ticket you are acting upon.""" collection_id: str r"""The collection ID""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -73,6 +77,20 @@ class IssueTrackingCollectionTicketsOneRequest(BaseModel): ] r"""The collection ID""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -94,7 +112,7 @@ class IssueTrackingCollectionTicketsOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py b/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py index b982c089..46304830 100644 --- a/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py +++ b/src/apideck_unify/models/issuetracking_collectionticketsupdateop.py @@ -50,6 +50,10 @@ class IssueTrackingCollectionTicketsUpdateRequestTypedDict(TypedDict): collection_id: str r"""The collection ID""" ticket: TicketInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -72,6 +76,20 @@ class IssueTrackingCollectionTicketsUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/issuetracking_collectionusersallop.py b/src/apideck_unify/models/issuetracking_collectionusersallop.py index a5606198..86d9455b 100644 --- a/src/apideck_unify/models/issuetracking_collectionusersallop.py +++ b/src/apideck_unify/models/issuetracking_collectionusersallop.py @@ -57,6 +57,10 @@ class IssueTrackingCollectionUsersAllRequestTypedDict(TypedDict): r"""The collection ID""" raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -81,6 +85,20 @@ class IssueTrackingCollectionUsersAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -116,6 +134,8 @@ class IssueTrackingCollectionUsersAllRequest(BaseModel): def serialize_model(self, handler): optional_fields = [ "raw", + "consumerId", + "appId", "serviceId", "cursor", "limit", diff --git a/src/apideck_unify/models/issuetracking_collectionusersoneop.py b/src/apideck_unify/models/issuetracking_collectionusersoneop.py index b6017ae4..75e231b6 100644 --- a/src/apideck_unify/models/issuetracking_collectionusersoneop.py +++ b/src/apideck_unify/models/issuetracking_collectionusersoneop.py @@ -57,6 +57,10 @@ class IssueTrackingCollectionUsersOneRequestTypedDict(TypedDict): r"""The collection ID""" id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -76,6 +80,20 @@ class IssueTrackingCollectionUsersOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -97,7 +115,7 @@ class IssueTrackingCollectionUsersOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/sms_messagesaddop.py b/src/apideck_unify/models/sms_messagesaddop.py index ddaf1cee..7c3dc499 100644 --- a/src/apideck_unify/models/sms_messagesaddop.py +++ b/src/apideck_unify/models/sms_messagesaddop.py @@ -47,6 +47,10 @@ class SmsMessagesAddRequestTypedDict(TypedDict): message: MessageInputTypedDict raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -63,6 +67,20 @@ class SmsMessagesAddRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/sms_messagesallop.py b/src/apideck_unify/models/sms_messagesallop.py index 2bed3da4..b157b139 100644 --- a/src/apideck_unify/models/sms_messagesallop.py +++ b/src/apideck_unify/models/sms_messagesallop.py @@ -47,6 +47,10 @@ class SmsMessagesAllGlobals(BaseModel): class SmsMessagesAllRequestTypedDict(TypedDict): raw: NotRequired[bool] r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" cursor: NotRequired[Nullable[str]] @@ -64,6 +68,20 @@ class SmsMessagesAllRequest(BaseModel): ] = False r"""Include raw response. Mostly used for debugging purposes""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -91,7 +109,15 @@ class SmsMessagesAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["raw", "serviceId", "cursor", "limit", "fields"] + optional_fields = [ + "raw", + "consumerId", + "appId", + "serviceId", + "cursor", + "limit", + "fields", + ] nullable_fields = ["cursor", "fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/sms_messagesdeleteop.py b/src/apideck_unify/models/sms_messagesdeleteop.py index 31a6ea0f..0894d7a7 100644 --- a/src/apideck_unify/models/sms_messagesdeleteop.py +++ b/src/apideck_unify/models/sms_messagesdeleteop.py @@ -45,6 +45,10 @@ class SmsMessagesDeleteGlobals(BaseModel): class SmsMessagesDeleteRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -57,6 +61,20 @@ class SmsMessagesDeleteRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/sms_messagesoneop.py b/src/apideck_unify/models/sms_messagesoneop.py index 33833788..e408fad1 100644 --- a/src/apideck_unify/models/sms_messagesoneop.py +++ b/src/apideck_unify/models/sms_messagesoneop.py @@ -52,6 +52,10 @@ class SmsMessagesOneGlobals(BaseModel): class SmsMessagesOneRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -66,6 +70,20 @@ class SmsMessagesOneRequest(BaseModel): ] r"""ID of the record you are acting upon.""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), @@ -87,7 +105,7 @@ class SmsMessagesOneRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["serviceId", "raw", "fields"] + optional_fields = ["consumerId", "appId", "serviceId", "raw", "fields"] nullable_fields = ["fields"] null_default_fields = [] diff --git a/src/apideck_unify/models/sms_messagesupdateop.py b/src/apideck_unify/models/sms_messagesupdateop.py index 60628f0d..ad223a1b 100644 --- a/src/apideck_unify/models/sms_messagesupdateop.py +++ b/src/apideck_unify/models/sms_messagesupdateop.py @@ -48,6 +48,10 @@ class SmsMessagesUpdateRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" message: MessageInputTypedDict + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" raw: NotRequired[bool] @@ -65,6 +69,20 @@ class SmsMessagesUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + service_id: Annotated[ Optional[str], pydantic.Field(alias="x-apideck-service-id"), diff --git a/src/apideck_unify/models/unifiedid.py b/src/apideck_unify/models/unifiedid.py index b18fa2c3..5304dfe3 100644 --- a/src/apideck_unify/models/unifiedid.py +++ b/src/apideck_unify/models/unifiedid.py @@ -6,10 +6,14 @@ class UnifiedIDTypedDict(TypedDict): + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" + id: str r"""The unique identifier of the resource""" class UnifiedID(BaseModel): + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" + id: str r"""The unique identifier of the resource""" diff --git a/src/apideck_unify/models/updateaccountingdepartmentresponse.py b/src/apideck_unify/models/updateaccountingdepartmentresponse.py index 45e93c92..131333d0 100644 --- a/src/apideck_unify/models/updateaccountingdepartmentresponse.py +++ b/src/apideck_unify/models/updateaccountingdepartmentresponse.py @@ -20,6 +20,7 @@ class UpdateAccountingDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateAccountingDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateAccountingDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateaccountinglocationresponse.py b/src/apideck_unify/models/updateaccountinglocationresponse.py index 7702cd90..69dc5d0f 100644 --- a/src/apideck_unify/models/updateaccountinglocationresponse.py +++ b/src/apideck_unify/models/updateaccountinglocationresponse.py @@ -20,6 +20,7 @@ class UpdateAccountingLocationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateAccountingLocationResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateAccountingLocationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateactivityresponse.py b/src/apideck_unify/models/updateactivityresponse.py index a5e1ff73..3d0c9666 100644 --- a/src/apideck_unify/models/updateactivityresponse.py +++ b/src/apideck_unify/models/updateactivityresponse.py @@ -20,6 +20,7 @@ class UpdateActivityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateActivityResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateActivityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateapplicantresponse.py b/src/apideck_unify/models/updateapplicantresponse.py index 27c53196..9cc128d6 100644 --- a/src/apideck_unify/models/updateapplicantresponse.py +++ b/src/apideck_unify/models/updateapplicantresponse.py @@ -20,6 +20,7 @@ class UpdateApplicantResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateApplicantResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateApplicantResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateapplicationresponse.py b/src/apideck_unify/models/updateapplicationresponse.py index 38010bf1..34bb93c6 100644 --- a/src/apideck_unify/models/updateapplicationresponse.py +++ b/src/apideck_unify/models/updateapplicationresponse.py @@ -20,6 +20,7 @@ class UpdateApplicationResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateApplicationResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateApplicationResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatebillpaymentresponse.py b/src/apideck_unify/models/updatebillpaymentresponse.py index 21bb2b8f..ff673040 100644 --- a/src/apideck_unify/models/updatebillpaymentresponse.py +++ b/src/apideck_unify/models/updatebillpaymentresponse.py @@ -20,6 +20,7 @@ class UpdateBillPaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateBillPaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateBillPaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatebillresponse.py b/src/apideck_unify/models/updatebillresponse.py index 539f5035..60578d74 100644 --- a/src/apideck_unify/models/updatebillresponse.py +++ b/src/apideck_unify/models/updatebillresponse.py @@ -20,6 +20,7 @@ class UpdateBillResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateBillResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateBillResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatecommentresponse.py b/src/apideck_unify/models/updatecommentresponse.py index a7a3306d..f0e538a0 100644 --- a/src/apideck_unify/models/updatecommentresponse.py +++ b/src/apideck_unify/models/updatecommentresponse.py @@ -20,6 +20,7 @@ class UpdateCommentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateCommentResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateCommentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatecompanyresponse.py b/src/apideck_unify/models/updatecompanyresponse.py index 44435034..ce1467f8 100644 --- a/src/apideck_unify/models/updatecompanyresponse.py +++ b/src/apideck_unify/models/updatecompanyresponse.py @@ -20,6 +20,7 @@ class UpdateCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatecontactresponse.py b/src/apideck_unify/models/updatecontactresponse.py index bc71a85a..815e72c5 100644 --- a/src/apideck_unify/models/updatecontactresponse.py +++ b/src/apideck_unify/models/updatecontactresponse.py @@ -20,6 +20,7 @@ class UpdateContactResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateContactResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateContactResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatecreditnoteresponse.py b/src/apideck_unify/models/updatecreditnoteresponse.py index 587b2c9e..48005294 100644 --- a/src/apideck_unify/models/updatecreditnoteresponse.py +++ b/src/apideck_unify/models/updatecreditnoteresponse.py @@ -20,6 +20,7 @@ class UpdateCreditNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateCreditNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateCreditNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatecustomerresponse.py b/src/apideck_unify/models/updatecustomerresponse.py index d41a4fa4..9b6d23b9 100644 --- a/src/apideck_unify/models/updatecustomerresponse.py +++ b/src/apideck_unify/models/updatecustomerresponse.py @@ -20,6 +20,7 @@ class UpdateCustomerResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateCustomerResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateCustomerResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatedepartmentresponse.py b/src/apideck_unify/models/updatedepartmentresponse.py index b5170f8c..dacba7a7 100644 --- a/src/apideck_unify/models/updatedepartmentresponse.py +++ b/src/apideck_unify/models/updatedepartmentresponse.py @@ -20,6 +20,7 @@ class UpdateDepartmentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateDepartmentResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateDepartmentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatedrivegroupresponse.py b/src/apideck_unify/models/updatedrivegroupresponse.py index da504882..ada75e92 100644 --- a/src/apideck_unify/models/updatedrivegroupresponse.py +++ b/src/apideck_unify/models/updatedrivegroupresponse.py @@ -20,6 +20,7 @@ class UpdateDriveGroupResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateDriveGroupResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateDriveGroupResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatedriveresponse.py b/src/apideck_unify/models/updatedriveresponse.py index 50e9b86a..7ade08c4 100644 --- a/src/apideck_unify/models/updatedriveresponse.py +++ b/src/apideck_unify/models/updatedriveresponse.py @@ -20,6 +20,7 @@ class UpdateDriveResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateDriveResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateDriveResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateemployeeresponse.py b/src/apideck_unify/models/updateemployeeresponse.py index f67e5762..c14dfaa2 100644 --- a/src/apideck_unify/models/updateemployeeresponse.py +++ b/src/apideck_unify/models/updateemployeeresponse.py @@ -20,6 +20,7 @@ class UpdateEmployeeResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateEmployeeResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateEmployeeResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateexpenseresponse.py b/src/apideck_unify/models/updateexpenseresponse.py index 014b91e1..dcec459c 100644 --- a/src/apideck_unify/models/updateexpenseresponse.py +++ b/src/apideck_unify/models/updateexpenseresponse.py @@ -20,6 +20,7 @@ class UpdateExpenseResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateExpenseResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateExpenseResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatefileresponse.py b/src/apideck_unify/models/updatefileresponse.py index 7999000c..54e5c777 100644 --- a/src/apideck_unify/models/updatefileresponse.py +++ b/src/apideck_unify/models/updatefileresponse.py @@ -20,6 +20,7 @@ class UpdateFileResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateFileResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateFileResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatefolderresponse.py b/src/apideck_unify/models/updatefolderresponse.py index 94f98516..34db2bf4 100644 --- a/src/apideck_unify/models/updatefolderresponse.py +++ b/src/apideck_unify/models/updatefolderresponse.py @@ -20,6 +20,7 @@ class UpdateFolderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateFolderResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateFolderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatehriscompanyresponse.py b/src/apideck_unify/models/updatehriscompanyresponse.py index 38af4921..36d1b9da 100644 --- a/src/apideck_unify/models/updatehriscompanyresponse.py +++ b/src/apideck_unify/models/updatehriscompanyresponse.py @@ -20,6 +20,7 @@ class UpdateHrisCompanyResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateHrisCompanyResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateHrisCompanyResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateinvoiceitemsresponse.py b/src/apideck_unify/models/updateinvoiceitemsresponse.py index cc53669b..2f11d785 100644 --- a/src/apideck_unify/models/updateinvoiceitemsresponse.py +++ b/src/apideck_unify/models/updateinvoiceitemsresponse.py @@ -20,6 +20,7 @@ class UpdateInvoiceItemsResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateInvoiceItemsResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateInvoiceItemsResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatejournalentryresponse.py b/src/apideck_unify/models/updatejournalentryresponse.py index 6f51ece9..c8cf0a7a 100644 --- a/src/apideck_unify/models/updatejournalentryresponse.py +++ b/src/apideck_unify/models/updatejournalentryresponse.py @@ -20,6 +20,7 @@ class UpdateJournalEntryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateJournalEntryResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateJournalEntryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateleadresponse.py b/src/apideck_unify/models/updateleadresponse.py index 8ae3d6c5..78d7a2d8 100644 --- a/src/apideck_unify/models/updateleadresponse.py +++ b/src/apideck_unify/models/updateleadresponse.py @@ -20,6 +20,7 @@ class UpdateLeadResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateLeadResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateLeadResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateledgeraccountresponse.py b/src/apideck_unify/models/updateledgeraccountresponse.py index 00dc0710..ca7b8cc7 100644 --- a/src/apideck_unify/models/updateledgeraccountresponse.py +++ b/src/apideck_unify/models/updateledgeraccountresponse.py @@ -20,6 +20,7 @@ class UpdateLedgerAccountResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateLedgerAccountResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateLedgerAccountResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatemessageresponse.py b/src/apideck_unify/models/updatemessageresponse.py index 591e6f47..65e1c3f5 100644 --- a/src/apideck_unify/models/updatemessageresponse.py +++ b/src/apideck_unify/models/updatemessageresponse.py @@ -20,6 +20,7 @@ class UpdateMessageResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateMessageResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateMessageResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatenoteresponse.py b/src/apideck_unify/models/updatenoteresponse.py index e1db51ce..ad6a4490 100644 --- a/src/apideck_unify/models/updatenoteresponse.py +++ b/src/apideck_unify/models/updatenoteresponse.py @@ -20,6 +20,7 @@ class UpdateNoteResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateNoteResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateNoteResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateopportunityresponse.py b/src/apideck_unify/models/updateopportunityresponse.py index f5e2d0d8..500831ef 100644 --- a/src/apideck_unify/models/updateopportunityresponse.py +++ b/src/apideck_unify/models/updateopportunityresponse.py @@ -20,6 +20,7 @@ class UpdateOpportunityResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateOpportunityResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateOpportunityResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatepaymentresponse.py b/src/apideck_unify/models/updatepaymentresponse.py index 7969b421..c88eaad1 100644 --- a/src/apideck_unify/models/updatepaymentresponse.py +++ b/src/apideck_unify/models/updatepaymentresponse.py @@ -20,6 +20,7 @@ class UpdatePaymentResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdatePaymentResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdatePaymentResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatepurchaseorderresponse.py b/src/apideck_unify/models/updatepurchaseorderresponse.py index 84f6016e..6b823791 100644 --- a/src/apideck_unify/models/updatepurchaseorderresponse.py +++ b/src/apideck_unify/models/updatepurchaseorderresponse.py @@ -20,6 +20,7 @@ class UpdatePurchaseOrderResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdatePurchaseOrderResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdatePurchaseOrderResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatesharedlinkresponse.py b/src/apideck_unify/models/updatesharedlinkresponse.py index cceda910..dbd72ac2 100644 --- a/src/apideck_unify/models/updatesharedlinkresponse.py +++ b/src/apideck_unify/models/updatesharedlinkresponse.py @@ -20,6 +20,7 @@ class UpdateSharedLinkResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateSharedLinkResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateSharedLinkResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatesubsidiaryresponse.py b/src/apideck_unify/models/updatesubsidiaryresponse.py index 83b702a3..cd622669 100644 --- a/src/apideck_unify/models/updatesubsidiaryresponse.py +++ b/src/apideck_unify/models/updatesubsidiaryresponse.py @@ -20,6 +20,7 @@ class UpdateSubsidiaryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateSubsidiaryResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateSubsidiaryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatesupplierresponse.py b/src/apideck_unify/models/updatesupplierresponse.py index df418d24..3213fca0 100644 --- a/src/apideck_unify/models/updatesupplierresponse.py +++ b/src/apideck_unify/models/updatesupplierresponse.py @@ -20,6 +20,7 @@ class UpdateSupplierResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateSupplierResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateSupplierResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatetaxrateresponse.py b/src/apideck_unify/models/updatetaxrateresponse.py index 7e6c7e56..ff290a64 100644 --- a/src/apideck_unify/models/updatetaxrateresponse.py +++ b/src/apideck_unify/models/updatetaxrateresponse.py @@ -20,6 +20,7 @@ class UpdateTaxRateResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateTaxRateResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateTaxRateResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateticketresponse.py b/src/apideck_unify/models/updateticketresponse.py index b7328046..180e2b97 100644 --- a/src/apideck_unify/models/updateticketresponse.py +++ b/src/apideck_unify/models/updateticketresponse.py @@ -20,6 +20,7 @@ class UpdateTicketResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateTicketResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateTicketResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatetimeoffrequestresponse.py b/src/apideck_unify/models/updatetimeoffrequestresponse.py index bac591f4..9636fa27 100644 --- a/src/apideck_unify/models/updatetimeoffrequestresponse.py +++ b/src/apideck_unify/models/updatetimeoffrequestresponse.py @@ -20,6 +20,7 @@ class UpdateTimeOffRequestResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateTimeOffRequestResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateTimeOffRequestResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updatetrackingcategoryresponse.py b/src/apideck_unify/models/updatetrackingcategoryresponse.py index 3fd056eb..ee721474 100644 --- a/src/apideck_unify/models/updatetrackingcategoryresponse.py +++ b/src/apideck_unify/models/updatetrackingcategoryresponse.py @@ -20,6 +20,7 @@ class UpdateTrackingCategoryResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateTrackingCategoryResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateTrackingCategoryResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/updateuserresponse.py b/src/apideck_unify/models/updateuserresponse.py index 9f9a08f2..8e357e8a 100644 --- a/src/apideck_unify/models/updateuserresponse.py +++ b/src/apideck_unify/models/updateuserresponse.py @@ -20,6 +20,7 @@ class UpdateUserResponseTypedDict(TypedDict): operation: str r"""Operation performed""" data: UnifiedIDTypedDict + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" class UpdateUserResponse(BaseModel): @@ -41,3 +42,4 @@ class UpdateUserResponse(BaseModel): r"""Operation performed""" data: UnifiedID + r"""A object containing a unique identifier for the resource that was created, updated, or deleted.""" diff --git a/src/apideck_unify/models/vault_connectioncustommappingsallop.py b/src/apideck_unify/models/vault_connectioncustommappingsallop.py index 3e1fb9b8..817969a0 100644 --- a/src/apideck_unify/models/vault_connectioncustommappingsallop.py +++ b/src/apideck_unify/models/vault_connectioncustommappingsallop.py @@ -52,6 +52,10 @@ class VaultConnectionCustomMappingsAllRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" resource: str r"""Name of the resource (plural)""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" resource_id: NotRequired[str] r"""This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id.""" @@ -72,6 +76,20 @@ class VaultConnectionCustomMappingsAllRequest(BaseModel): ] r"""Name of the resource (plural)""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + resource_id: Annotated[ Optional[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), diff --git a/src/apideck_unify/models/vault_connectionsallop.py b/src/apideck_unify/models/vault_connectionsallop.py index e65dd49d..8cac5834 100644 --- a/src/apideck_unify/models/vault_connectionsallop.py +++ b/src/apideck_unify/models/vault_connectionsallop.py @@ -41,6 +41,10 @@ class VaultConnectionsAllGlobals(BaseModel): class VaultConnectionsAllRequestTypedDict(TypedDict): + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" api: NotRequired[str] r"""Scope results to Unified API""" configured: NotRequired[bool] @@ -48,6 +52,20 @@ class VaultConnectionsAllRequestTypedDict(TypedDict): class VaultConnectionsAllRequest(BaseModel): + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + api: Annotated[ Optional[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), diff --git a/src/apideck_unify/models/vault_connectionsdeleteop.py b/src/apideck_unify/models/vault_connectionsdeleteop.py index 3b7070a5..4ac2015f 100644 --- a/src/apideck_unify/models/vault_connectionsdeleteop.py +++ b/src/apideck_unify/models/vault_connectionsdeleteop.py @@ -41,6 +41,10 @@ class VaultConnectionsDeleteRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" unified_api: str r"""Unified API""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionsDeleteRequest(BaseModel): @@ -54,6 +58,20 @@ class VaultConnectionsDeleteRequest(BaseModel): ] r"""Unified API""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionsDeleteResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_connectionsettingsallop.py b/src/apideck_unify/models/vault_connectionsettingsallop.py index 48348f18..7fa9134c 100644 --- a/src/apideck_unify/models/vault_connectionsettingsallop.py +++ b/src/apideck_unify/models/vault_connectionsettingsallop.py @@ -44,6 +44,10 @@ class VaultConnectionSettingsAllRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" resource: str r"""Name of the resource (plural)""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionSettingsAllRequest(BaseModel): @@ -62,6 +66,20 @@ class VaultConnectionSettingsAllRequest(BaseModel): ] r"""Name of the resource (plural)""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionSettingsAllResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_connectionsettingsupdateop.py b/src/apideck_unify/models/vault_connectionsettingsupdateop.py index 76713338..29674df6 100644 --- a/src/apideck_unify/models/vault_connectionsettingsupdateop.py +++ b/src/apideck_unify/models/vault_connectionsettingsupdateop.py @@ -55,6 +55,10 @@ class VaultConnectionSettingsUpdateRequestTypedDict(TypedDict): r"""Name of the resource (plural)""" connection: ConnectionInputTypedDict r"""Fields that need to be updated on the resource""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionSettingsUpdateRequest(BaseModel): @@ -79,6 +83,20 @@ class VaultConnectionSettingsUpdateRequest(BaseModel): ] r"""Fields that need to be updated on the resource""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionSettingsUpdateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_connectionsimportop.py b/src/apideck_unify/models/vault_connectionsimportop.py index 41b3744f..83cb4950 100644 --- a/src/apideck_unify/models/vault_connectionsimportop.py +++ b/src/apideck_unify/models/vault_connectionsimportop.py @@ -53,6 +53,10 @@ class VaultConnectionsImportRequestTypedDict(TypedDict): r"""Unified API""" connection_import_data: ConnectionImportDataTypedDict r"""Fields that need to be persisted on the resource""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionsImportRequest(BaseModel): @@ -72,6 +76,20 @@ class VaultConnectionsImportRequest(BaseModel): ] r"""Fields that need to be persisted on the resource""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionsImportResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_connectionsoneop.py b/src/apideck_unify/models/vault_connectionsoneop.py index a0f912a4..8578c27a 100644 --- a/src/apideck_unify/models/vault_connectionsoneop.py +++ b/src/apideck_unify/models/vault_connectionsoneop.py @@ -42,6 +42,10 @@ class VaultConnectionsOneRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" unified_api: str r"""Unified API""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionsOneRequest(BaseModel): @@ -55,6 +59,20 @@ class VaultConnectionsOneRequest(BaseModel): ] r"""Unified API""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionsOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_connectionstokenop.py b/src/apideck_unify/models/vault_connectionstokenop.py index fc137b76..3be7003b 100644 --- a/src/apideck_unify/models/vault_connectionstokenop.py +++ b/src/apideck_unify/models/vault_connectionstokenop.py @@ -55,6 +55,10 @@ class VaultConnectionsTokenRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" unified_api: str r"""Unified API""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" request_body: NotRequired[VaultConnectionsTokenRequestBodyTypedDict] @@ -69,6 +73,20 @@ class VaultConnectionsTokenRequest(BaseModel): ] r"""Unified API""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + request_body: Annotated[ Optional[VaultConnectionsTokenRequestBody], FieldMetadata(request=RequestMetadata(media_type="application/json")), diff --git a/src/apideck_unify/models/vault_connectionsupdateop.py b/src/apideck_unify/models/vault_connectionsupdateop.py index f61e02a4..0a0b0934 100644 --- a/src/apideck_unify/models/vault_connectionsupdateop.py +++ b/src/apideck_unify/models/vault_connectionsupdateop.py @@ -53,6 +53,10 @@ class VaultConnectionsUpdateRequestTypedDict(TypedDict): r"""Unified API""" connection: ConnectionInputTypedDict r"""Fields that need to be updated on the resource""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConnectionsUpdateRequest(BaseModel): @@ -72,6 +76,20 @@ class VaultConnectionsUpdateRequest(BaseModel): ] r"""Fields that need to be updated on the resource""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConnectionsUpdateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_consumerrequestcountsallop.py b/src/apideck_unify/models/vault_consumerrequestcountsallop.py index d6061c38..6e2a686a 100644 --- a/src/apideck_unify/models/vault_consumerrequestcountsallop.py +++ b/src/apideck_unify/models/vault_consumerrequestcountsallop.py @@ -43,6 +43,8 @@ class VaultConsumerRequestCountsAllRequestTypedDict(TypedDict): r"""Scopes results to requests that happened after datetime""" end_datetime: str r"""Scopes results to requests that happened before datetime""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConsumerRequestCountsAllRequest(BaseModel): @@ -61,6 +63,13 @@ class VaultConsumerRequestCountsAllRequest(BaseModel): ] r"""Scopes results to requests that happened before datetime""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConsumerRequestCountsAllResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_consumersaddop.py b/src/apideck_unify/models/vault_consumersaddop.py index 1ed18c07..00f600f3 100644 --- a/src/apideck_unify/models/vault_consumersaddop.py +++ b/src/apideck_unify/models/vault_consumersaddop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .consumer_input import ConsumerInput, ConsumerInputTypedDict from .createconsumerresponse import ( CreateConsumerResponse, CreateConsumerResponseTypedDict, @@ -11,7 +12,7 @@ UnexpectedErrorResponseTypedDict, ) from apideck_unify.types import BaseModel -from apideck_unify.utils import FieldMetadata, HeaderMetadata +from apideck_unify.utils import FieldMetadata, HeaderMetadata, RequestMetadata import pydantic from typing import Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -31,6 +32,26 @@ class VaultConsumersAddGlobals(BaseModel): r"""The ID of your Unify application""" +class VaultConsumersAddRequestTypedDict(TypedDict): + consumer: ConsumerInputTypedDict + app_id: NotRequired[str] + r"""The ID of your Unify application""" + + +class VaultConsumersAddRequest(BaseModel): + consumer: Annotated[ + ConsumerInput, + FieldMetadata(request=RequestMetadata(media_type="application/json")), + ] + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + + class VaultConsumersAddResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict create_consumer_response: NotRequired[CreateConsumerResponseTypedDict] diff --git a/src/apideck_unify/models/vault_consumersallop.py b/src/apideck_unify/models/vault_consumersallop.py index 91304873..65daea1c 100644 --- a/src/apideck_unify/models/vault_consumersallop.py +++ b/src/apideck_unify/models/vault_consumersallop.py @@ -36,6 +36,8 @@ class VaultConsumersAllGlobals(BaseModel): class VaultConsumersAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" cursor: NotRequired[Nullable[str]] r"""Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.""" limit: NotRequired[int] @@ -43,6 +45,13 @@ class VaultConsumersAllRequestTypedDict(TypedDict): class VaultConsumersAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + cursor: Annotated[ OptionalNullable[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -57,7 +66,7 @@ class VaultConsumersAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["cursor", "limit"] + optional_fields = ["appId", "cursor", "limit"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/vault_consumersdeleteop.py b/src/apideck_unify/models/vault_consumersdeleteop.py index e7e3076b..fc7652d3 100644 --- a/src/apideck_unify/models/vault_consumersdeleteop.py +++ b/src/apideck_unify/models/vault_consumersdeleteop.py @@ -34,6 +34,8 @@ class VaultConsumersDeleteGlobals(BaseModel): class VaultConsumersDeleteRequestTypedDict(TypedDict): consumer_id: str r"""ID of the consumer to return""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConsumersDeleteRequest(BaseModel): @@ -42,6 +44,13 @@ class VaultConsumersDeleteRequest(BaseModel): ] r"""ID of the consumer to return""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConsumersDeleteResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_consumersoneop.py b/src/apideck_unify/models/vault_consumersoneop.py index 95c11006..02a5f237 100644 --- a/src/apideck_unify/models/vault_consumersoneop.py +++ b/src/apideck_unify/models/vault_consumersoneop.py @@ -31,6 +31,8 @@ class VaultConsumersOneGlobals(BaseModel): class VaultConsumersOneRequestTypedDict(TypedDict): consumer_id: str r"""ID of the consumer to return""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConsumersOneRequest(BaseModel): @@ -39,6 +41,13 @@ class VaultConsumersOneRequest(BaseModel): ] r"""ID of the consumer to return""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConsumersOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_consumersupdateop.py b/src/apideck_unify/models/vault_consumersupdateop.py index 1e8b8d52..708d70f1 100644 --- a/src/apideck_unify/models/vault_consumersupdateop.py +++ b/src/apideck_unify/models/vault_consumersupdateop.py @@ -41,6 +41,8 @@ class VaultConsumersUpdateRequestTypedDict(TypedDict): consumer_id: str r"""ID of the consumer to return""" update_consumer_request: UpdateConsumerRequestTypedDict + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultConsumersUpdateRequest(BaseModel): @@ -54,6 +56,13 @@ class VaultConsumersUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultConsumersUpdateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_createcallbackstateop.py b/src/apideck_unify/models/vault_createcallbackstateop.py index d94edb53..96f611d8 100644 --- a/src/apideck_unify/models/vault_createcallbackstateop.py +++ b/src/apideck_unify/models/vault_createcallbackstateop.py @@ -53,6 +53,10 @@ class VaultCreateCallbackStateRequestTypedDict(TypedDict): r"""Unified API""" create_callback_state: CreateCallbackStateTypedDict r"""Callback state data""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultCreateCallbackStateRequest(BaseModel): @@ -72,6 +76,20 @@ class VaultCreateCallbackStateRequest(BaseModel): ] r"""Callback state data""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultCreateCallbackStateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_customfieldsallop.py b/src/apideck_unify/models/vault_customfieldsallop.py index fc889043..1aff2b54 100644 --- a/src/apideck_unify/models/vault_customfieldsallop.py +++ b/src/apideck_unify/models/vault_customfieldsallop.py @@ -52,6 +52,10 @@ class VaultCustomFieldsAllRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" resource: str r"""Name of the resource (plural)""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" resource_id: NotRequired[str] r"""This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id.""" @@ -72,6 +76,20 @@ class VaultCustomFieldsAllRequest(BaseModel): ] r"""Name of the resource (plural)""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + resource_id: Annotated[ Optional[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), diff --git a/src/apideck_unify/models/vault_custommappingsallop.py b/src/apideck_unify/models/vault_custommappingsallop.py index 5fcef13e..0a95c74b 100644 --- a/src/apideck_unify/models/vault_custommappingsallop.py +++ b/src/apideck_unify/models/vault_custommappingsallop.py @@ -45,6 +45,10 @@ class VaultCustomMappingsAllRequestTypedDict(TypedDict): r"""Unified API""" service_id: str r"""Service ID of the resource to return""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class VaultCustomMappingsAllRequest(BaseModel): @@ -58,6 +62,20 @@ class VaultCustomMappingsAllRequest(BaseModel): ] r"""Service ID of the resource to return""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class VaultCustomMappingsAllResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/vault_logsallop.py b/src/apideck_unify/models/vault_logsallop.py index 3905f36a..12cd005a 100644 --- a/src/apideck_unify/models/vault_logsallop.py +++ b/src/apideck_unify/models/vault_logsallop.py @@ -46,6 +46,10 @@ class VaultLogsAllGlobals(BaseModel): class VaultLogsAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" filter_: NotRequired[LogsFilterTypedDict] r"""Filter results""" cursor: NotRequired[Nullable[str]] @@ -55,6 +59,20 @@ class VaultLogsAllRequestTypedDict(TypedDict): class VaultLogsAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + filter_: Annotated[ Optional[LogsFilter], pydantic.Field(alias="filter"), @@ -76,7 +94,7 @@ class VaultLogsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["filter", "cursor", "limit"] + optional_fields = ["appId", "consumerId", "filter", "cursor", "limit"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/vault_sessionscreateop.py b/src/apideck_unify/models/vault_sessionscreateop.py index bac10b7a..d67236e6 100644 --- a/src/apideck_unify/models/vault_sessionscreateop.py +++ b/src/apideck_unify/models/vault_sessionscreateop.py @@ -3,12 +3,13 @@ from __future__ import annotations from .createsessionresponse import CreateSessionResponse, CreateSessionResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict +from .session import Session, SessionTypedDict from .unexpectederrorresponse import ( UnexpectedErrorResponse, UnexpectedErrorResponseTypedDict, ) from apideck_unify.types import BaseModel -from apideck_unify.utils import FieldMetadata, HeaderMetadata +from apideck_unify.utils import FieldMetadata, HeaderMetadata, RequestMetadata import pydantic from typing import Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -37,6 +38,37 @@ class VaultSessionsCreateGlobals(BaseModel): r"""The ID of your Unify application""" +class VaultSessionsCreateRequestTypedDict(TypedDict): + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" + session: NotRequired[SessionTypedDict] + r"""Additional redirect uri and/or consumer metadata""" + + +class VaultSessionsCreateRequest(BaseModel): + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + + session: Annotated[ + Optional[Session], + FieldMetadata(request=RequestMetadata(media_type="application/json")), + ] = None + r"""Additional redirect uri and/or consumer metadata""" + + class VaultSessionsCreateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict create_session_response: NotRequired[CreateSessionResponseTypedDict] diff --git a/src/apideck_unify/models/vault_validateconnectionstateop.py b/src/apideck_unify/models/vault_validateconnectionstateop.py index 4e127c4a..873cbfed 100644 --- a/src/apideck_unify/models/vault_validateconnectionstateop.py +++ b/src/apideck_unify/models/vault_validateconnectionstateop.py @@ -58,6 +58,10 @@ class VaultValidateConnectionStateRequestTypedDict(TypedDict): r"""Service ID of the resource to return""" unified_api: str r"""Unified API""" + consumer_id: NotRequired[str] + r"""ID of the consumer which you want to get or push data from""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" request_body: NotRequired[VaultValidateConnectionStateRequestBodyTypedDict] @@ -72,6 +76,20 @@ class VaultValidateConnectionStateRequest(BaseModel): ] r"""Unified API""" + consumer_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-consumer-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""ID of the consumer which you want to get or push data from""" + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + request_body: Annotated[ Optional[VaultValidateConnectionStateRequestBody], FieldMetadata(request=RequestMetadata(media_type="application/json")), diff --git a/src/apideck_unify/models/webhook_eventlogsallop.py b/src/apideck_unify/models/webhook_eventlogsallop.py index 6e98ee3c..dfa8cac7 100644 --- a/src/apideck_unify/models/webhook_eventlogsallop.py +++ b/src/apideck_unify/models/webhook_eventlogsallop.py @@ -43,6 +43,8 @@ class WebhookEventLogsAllGlobals(BaseModel): class WebhookEventLogsAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" cursor: NotRequired[Nullable[str]] r"""Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.""" limit: NotRequired[int] @@ -52,6 +54,13 @@ class WebhookEventLogsAllRequestTypedDict(TypedDict): class WebhookEventLogsAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + cursor: Annotated[ OptionalNullable[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -73,7 +82,7 @@ class WebhookEventLogsAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["cursor", "limit", "filter"] + optional_fields = ["appId", "cursor", "limit", "filter"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/webhook_webhooksaddop.py b/src/apideck_unify/models/webhook_webhooksaddop.py index 2ecf2427..bc6d81b7 100644 --- a/src/apideck_unify/models/webhook_webhooksaddop.py +++ b/src/apideck_unify/models/webhook_webhooksaddop.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .createwebhookrequest import CreateWebhookRequest, CreateWebhookRequestTypedDict from .createwebhookresponse import CreateWebhookResponse, CreateWebhookResponseTypedDict from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict from .unexpectederrorresponse import ( @@ -8,7 +9,7 @@ UnexpectedErrorResponseTypedDict, ) from apideck_unify.types import BaseModel -from apideck_unify.utils import FieldMetadata, HeaderMetadata +from apideck_unify.utils import FieldMetadata, HeaderMetadata, RequestMetadata import pydantic from typing import Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -28,6 +29,26 @@ class WebhookWebhooksAddGlobals(BaseModel): r"""The ID of your Unify application""" +class WebhookWebhooksAddRequestTypedDict(TypedDict): + create_webhook_request: CreateWebhookRequestTypedDict + app_id: NotRequired[str] + r"""The ID of your Unify application""" + + +class WebhookWebhooksAddRequest(BaseModel): + create_webhook_request: Annotated[ + CreateWebhookRequest, + FieldMetadata(request=RequestMetadata(media_type="application/json")), + ] + + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + + class WebhookWebhooksAddResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict create_webhook_response: NotRequired[CreateWebhookResponseTypedDict] diff --git a/src/apideck_unify/models/webhook_webhooksallop.py b/src/apideck_unify/models/webhook_webhooksallop.py index 7853ebb7..e4b86619 100644 --- a/src/apideck_unify/models/webhook_webhooksallop.py +++ b/src/apideck_unify/models/webhook_webhooksallop.py @@ -36,6 +36,8 @@ class WebhookWebhooksAllGlobals(BaseModel): class WebhookWebhooksAllRequestTypedDict(TypedDict): + app_id: NotRequired[str] + r"""The ID of your Unify application""" cursor: NotRequired[Nullable[str]] r"""Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.""" limit: NotRequired[int] @@ -43,6 +45,13 @@ class WebhookWebhooksAllRequestTypedDict(TypedDict): class WebhookWebhooksAllRequest(BaseModel): + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + cursor: Annotated[ OptionalNullable[str], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -57,7 +66,7 @@ class WebhookWebhooksAllRequest(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["cursor", "limit"] + optional_fields = ["appId", "cursor", "limit"] nullable_fields = ["cursor"] null_default_fields = [] diff --git a/src/apideck_unify/models/webhook_webhooksdeleteop.py b/src/apideck_unify/models/webhook_webhooksdeleteop.py index 7d48898e..dc150582 100644 --- a/src/apideck_unify/models/webhook_webhooksdeleteop.py +++ b/src/apideck_unify/models/webhook_webhooksdeleteop.py @@ -31,6 +31,8 @@ class WebhookWebhooksDeleteGlobals(BaseModel): class WebhookWebhooksDeleteRequestTypedDict(TypedDict): id: str r"""JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class WebhookWebhooksDeleteRequest(BaseModel): @@ -39,6 +41,13 @@ class WebhookWebhooksDeleteRequest(BaseModel): ] r"""JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class WebhookWebhooksDeleteResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/webhook_webhooksoneop.py b/src/apideck_unify/models/webhook_webhooksoneop.py index 001397cd..c69248ca 100644 --- a/src/apideck_unify/models/webhook_webhooksoneop.py +++ b/src/apideck_unify/models/webhook_webhooksoneop.py @@ -31,6 +31,8 @@ class WebhookWebhooksOneGlobals(BaseModel): class WebhookWebhooksOneRequestTypedDict(TypedDict): id: str r"""JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.""" + app_id: NotRequired[str] + r"""The ID of your Unify application""" class WebhookWebhooksOneRequest(BaseModel): @@ -39,6 +41,13 @@ class WebhookWebhooksOneRequest(BaseModel): ] r"""JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.""" + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class WebhookWebhooksOneResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/models/webhook_webhooksupdateop.py b/src/apideck_unify/models/webhook_webhooksupdateop.py index ba604e2e..94ebf230 100644 --- a/src/apideck_unify/models/webhook_webhooksupdateop.py +++ b/src/apideck_unify/models/webhook_webhooksupdateop.py @@ -38,6 +38,8 @@ class WebhookWebhooksUpdateRequestTypedDict(TypedDict): id: str r"""JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.""" update_webhook_request: UpdateWebhookRequestTypedDict + app_id: NotRequired[str] + r"""The ID of your Unify application""" class WebhookWebhooksUpdateRequest(BaseModel): @@ -51,6 +53,13 @@ class WebhookWebhooksUpdateRequest(BaseModel): FieldMetadata(request=RequestMetadata(media_type="application/json")), ] + app_id: Annotated[ + Optional[str], + pydantic.Field(alias="x-apideck-app-id"), + FieldMetadata(header=HeaderMetadata(style="simple", explode=False)), + ] = None + r"""The ID of your Unify application""" + class WebhookWebhooksUpdateResponseTypedDict(TypedDict): http_meta: HTTPMetadataTypedDict diff --git a/src/apideck_unify/notes.py b/src/apideck_unify/notes.py index 7cef2fd9..b5c19d30 100644 --- a/src/apideck_unify/notes.py +++ b/src/apideck_unify/notes.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List notes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.CrmNotesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.CrmNotesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List notes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.CrmNotesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.CrmNotesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -340,6 +356,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, title: OptionalNullable[str] = UNSET, content: OptionalNullable[str] = UNSET, @@ -362,6 +380,8 @@ def create( Create note :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param title: The title of the note :param content: The content of the note. @@ -387,6 +407,8 @@ def create( request = models.CrmNotesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, note=models.NoteInput( title=title, @@ -507,6 +529,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, title: OptionalNullable[str] = UNSET, content: OptionalNullable[str] = UNSET, @@ -529,6 +553,8 @@ async def create_async( Create note :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param title: The title of the note :param content: The content of the note. @@ -554,6 +580,8 @@ async def create_async( request = models.CrmNotesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, note=models.NoteInput( title=title, @@ -674,6 +702,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -687,6 +717,8 @@ def get( Get note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -705,6 +737,8 @@ def get( request = models.CrmNotesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -811,6 +845,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -824,6 +860,8 @@ async def get_async( Get note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -842,6 +880,8 @@ async def get_async( request = models.CrmNotesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -948,6 +988,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, title: OptionalNullable[str] = UNSET, @@ -971,6 +1013,8 @@ def update( Update note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param title: The title of the note @@ -997,6 +1041,8 @@ def update( request = models.CrmNotesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, note=models.NoteInput( @@ -1118,6 +1164,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, title: OptionalNullable[str] = UNSET, @@ -1141,6 +1189,8 @@ async def update_async( Update note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param title: The title of the note @@ -1167,6 +1217,8 @@ async def update_async( request = models.CrmNotesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, note=models.NoteInput( @@ -1288,6 +1340,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1300,6 +1354,8 @@ def delete( Delete note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1317,6 +1373,8 @@ def delete( request = models.CrmNotesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1422,6 +1480,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1434,6 +1494,8 @@ async def delete_async( Delete note :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1451,6 +1513,8 @@ async def delete_async( request = models.CrmNotesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/opportunities.py b/src/apideck_unify/opportunities.py index aaaa0179..610fc005 100644 --- a/src/apideck_unify/opportunities.py +++ b/src/apideck_unify/opportunities.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -36,6 +38,8 @@ def list( List opportunities :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -58,6 +62,8 @@ def list( request = models.CrmOpportunitiesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -124,6 +130,8 @@ def next_func() -> Optional[models.CrmOpportunitiesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -192,6 +200,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -213,6 +223,8 @@ async def list_async( List opportunities :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -235,6 +247,8 @@ async def list_async( request = models.CrmOpportunitiesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -301,6 +315,8 @@ def next_func() -> Optional[models.CrmOpportunitiesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -371,6 +387,8 @@ def create( title: str, primary_contact_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, type_: OptionalNullable[str] = UNSET, @@ -415,6 +433,8 @@ def create( :param title: The title or name of the opportunity. :param primary_contact_id: The unique identifier of the primary contact associated with the opportunity. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param description: A description of the opportunity. :param type: The type of the opportunity @@ -458,6 +478,8 @@ def create( request = models.CrmOpportunitiesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, opportunity=models.OpportunityInput( title=title, @@ -602,6 +624,8 @@ async def create_async( title: str, primary_contact_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, type_: OptionalNullable[str] = UNSET, @@ -646,6 +670,8 @@ async def create_async( :param title: The title or name of the opportunity. :param primary_contact_id: The unique identifier of the primary contact associated with the opportunity. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param description: A description of the opportunity. :param type: The type of the opportunity @@ -689,6 +715,8 @@ async def create_async( request = models.CrmOpportunitiesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, opportunity=models.OpportunityInput( title=title, @@ -831,6 +859,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -844,6 +874,8 @@ def get( Get opportunity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -862,6 +894,8 @@ def get( request = models.CrmOpportunitiesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -968,6 +1002,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -981,6 +1017,8 @@ async def get_async( Get opportunity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -999,6 +1037,8 @@ async def get_async( request = models.CrmOpportunitiesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1107,6 +1147,8 @@ def update( id: str, title: str, primary_contact_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, description: OptionalNullable[str] = UNSET, @@ -1152,6 +1194,8 @@ def update( :param id: ID of the record you are acting upon. :param title: The title or name of the opportunity. :param primary_contact_id: The unique identifier of the primary contact associated with the opportunity. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param description: A description of the opportunity. @@ -1196,6 +1240,8 @@ def update( request = models.CrmOpportunitiesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, opportunity=models.OpportunityInput( @@ -1341,6 +1387,8 @@ async def update_async( id: str, title: str, primary_contact_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, description: OptionalNullable[str] = UNSET, @@ -1386,6 +1434,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param title: The title or name of the opportunity. :param primary_contact_id: The unique identifier of the primary contact associated with the opportunity. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param description: A description of the opportunity. @@ -1430,6 +1480,8 @@ async def update_async( request = models.CrmOpportunitiesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, opportunity=models.OpportunityInput( @@ -1573,6 +1625,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1585,6 +1639,8 @@ def delete( Delete opportunity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1602,6 +1658,8 @@ def delete( request = models.CrmOpportunitiesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1707,6 +1765,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1719,6 +1779,8 @@ async def delete_async( Delete opportunity :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1736,6 +1798,8 @@ async def delete_async( request = models.CrmOpportunitiesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/orders.py b/src/apideck_unify/orders.py index e188a998..26de8f9e 100644 --- a/src/apideck_unify/orders.py +++ b/src/apideck_unify/orders.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( List Orders :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -55,6 +59,8 @@ def list( request = models.EcommerceOrdersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -121,6 +127,8 @@ def next_func() -> Optional[models.EcommerceOrdersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -189,6 +197,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -208,6 +218,8 @@ async def list_async( List Orders :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -230,6 +242,8 @@ async def list_async( request = models.EcommerceOrdersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -296,6 +310,8 @@ def next_func() -> Optional[models.EcommerceOrdersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -364,6 +380,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -377,6 +395,8 @@ def get( Get Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -395,6 +415,8 @@ def get( request = models.EcommerceOrdersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -501,6 +523,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -514,6 +538,8 @@ async def get_async( Get Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -532,6 +558,8 @@ async def get_async( request = models.EcommerceOrdersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/payments.py b/src/apideck_unify/payments.py index 4a5d7544..de84f10d 100644 --- a/src/apideck_unify/payments.py +++ b/src/apideck_unify/payments.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -34,6 +36,8 @@ def list( List Payments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -56,6 +60,8 @@ def list( request = models.AccountingPaymentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -120,6 +126,8 @@ def next_func() -> Optional[models.AccountingPaymentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -207,6 +217,8 @@ async def list_async( List Payments :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -229,6 +241,8 @@ async def list_async( request = models.AccountingPaymentsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -293,6 +307,8 @@ def next_func() -> Optional[models.AccountingPaymentsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -363,6 +379,8 @@ def create( total_amount: Nullable[float], transaction_date: Nullable[datetime], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -422,6 +440,8 @@ def create( :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -461,6 +481,8 @@ def create( request = models.AccountingPaymentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, payment=models.PaymentInput( currency=currency, @@ -612,6 +634,8 @@ async def create_async( total_amount: Nullable[float], transaction_date: Nullable[datetime], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, currency: OptionalNullable[models.Currency] = UNSET, currency_rate: OptionalNullable[float] = UNSET, @@ -671,6 +695,8 @@ async def create_async( :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). :param currency_rate: Currency Exchange Rate at the time entity was recorded/generated. @@ -710,6 +736,8 @@ async def create_async( request = models.AccountingPaymentsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, payment=models.PaymentInput( currency=currency, @@ -859,6 +887,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -872,6 +902,8 @@ def get( Get Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -890,6 +922,8 @@ def get( request = models.AccountingPaymentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -996,6 +1030,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1009,6 +1045,8 @@ async def get_async( Get Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1027,6 +1065,8 @@ async def get_async( request = models.AccountingPaymentsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1135,6 +1175,8 @@ def update( id: str, total_amount: Nullable[float], transaction_date: Nullable[datetime], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, currency: OptionalNullable[models.Currency] = UNSET, @@ -1195,6 +1237,8 @@ def update( :param id: ID of the record you are acting upon. :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1235,6 +1279,8 @@ def update( request = models.AccountingPaymentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, payment=models.PaymentInput( @@ -1387,6 +1433,8 @@ async def update_async( id: str, total_amount: Nullable[float], transaction_date: Nullable[datetime], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, currency: OptionalNullable[models.Currency] = UNSET, @@ -1447,6 +1495,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param total_amount: The total amount of the transaction :param transaction_date: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param currency: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). @@ -1487,6 +1537,8 @@ async def update_async( request = models.AccountingPaymentsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, payment=models.PaymentInput( @@ -1637,6 +1689,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1649,6 +1703,8 @@ def delete( Delete Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1666,6 +1722,8 @@ def delete( request = models.AccountingPaymentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1771,6 +1829,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1783,6 +1843,8 @@ async def delete_async( Delete Payment :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1800,6 +1862,8 @@ async def delete_async( request = models.AccountingPaymentsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/payrolls.py b/src/apideck_unify/payrolls.py index 26ec7c2e..2f91b867 100644 --- a/src/apideck_unify/payrolls.py +++ b/src/apideck_unify/payrolls.py @@ -13,6 +13,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.PayrollsFilter, models.PayrollsFilterTypedDict] @@ -29,6 +31,8 @@ def list( List Payroll :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -48,6 +52,8 @@ def list( request = models.HrisPayrollsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model(filter_, Optional[models.PayrollsFilter]), pass_through=pass_through, @@ -155,6 +161,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.PayrollsFilter, models.PayrollsFilterTypedDict] @@ -171,6 +179,8 @@ async def list_async( List Payroll :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -190,6 +200,8 @@ async def list_async( request = models.HrisPayrollsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model(filter_, Optional[models.PayrollsFilter]), pass_through=pass_through, @@ -298,6 +310,8 @@ def get( *, payroll_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -311,6 +325,8 @@ def get( :param payroll_id: ID of the payroll you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -329,6 +345,8 @@ def get( request = models.HrisPayrollsOneRequest( payroll_id=payroll_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) @@ -435,6 +453,8 @@ async def get_async( *, payroll_id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -448,6 +468,8 @@ async def get_async( :param payroll_id: ID of the payroll you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -466,6 +488,8 @@ async def get_async( request = models.HrisPayrollsOneRequest( payroll_id=payroll_id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, fields=fields, ) diff --git a/src/apideck_unify/pipelines.py b/src/apideck_unify/pipelines.py index 9b9aa60a..b6b1b3cc 100644 --- a/src/apideck_unify/pipelines.py +++ b/src/apideck_unify/pipelines.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List pipelines :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.CrmPipelinesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.CrmPipelinesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List pipelines :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.CrmPipelinesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.CrmPipelinesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, diff --git a/src/apideck_unify/products.py b/src/apideck_unify/products.py index 27e57c32..d1436da2 100644 --- a/src/apideck_unify/products.py +++ b/src/apideck_unify/products.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Products :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.EcommerceProductsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.EcommerceProductsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List Products :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.EcommerceProductsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.EcommerceProductsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -340,6 +356,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -353,6 +371,8 @@ def get( Get Product :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -371,6 +391,8 @@ def get( request = models.EcommerceProductsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -477,6 +499,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -490,6 +514,8 @@ async def get_async( Get Product :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -508,6 +534,8 @@ async def get_async( request = models.EcommerceProductsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/profitandloss_sdk.py b/src/apideck_unify/profitandloss_sdk.py index 79887722..40a9a554 100644 --- a/src/apideck_unify/profitandloss_sdk.py +++ b/src/apideck_unify/profitandloss_sdk.py @@ -13,6 +13,8 @@ def get( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.ProfitAndLossFilter, models.ProfitAndLossFilterTypedDict] @@ -29,6 +31,8 @@ def get( Get Profit and Loss :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -48,6 +52,8 @@ def get( request = models.AccountingProfitAndLossOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model( filter_, Optional[models.ProfitAndLossFilter] @@ -157,6 +163,8 @@ async def get_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, filter_: Optional[ Union[models.ProfitAndLossFilter, models.ProfitAndLossFilterTypedDict] @@ -173,6 +181,8 @@ async def get_async( Get Profit and Loss :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param filter_: Apply filters :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -192,6 +202,8 @@ async def get_async( request = models.AccountingProfitAndLossOneRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, filter_=utils.get_pydantic_model( filter_, Optional[models.ProfitAndLossFilter] diff --git a/src/apideck_unify/purchaseorders.py b/src/apideck_unify/purchaseorders.py index 3ba094e1..07a78231 100644 --- a/src/apideck_unify/purchaseorders.py +++ b/src/apideck_unify/purchaseorders.py @@ -15,6 +15,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, pass_through: Optional[Dict[str, Any]] = None, @@ -35,6 +37,8 @@ def list( List Purchase Orders :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -56,6 +60,8 @@ def list( request = models.AccountingPurchaseOrdersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, pass_through=pass_through, @@ -121,6 +127,8 @@ def next_func() -> Optional[models.AccountingPurchaseOrdersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, pass_through=pass_through, @@ -188,6 +196,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, pass_through: Optional[Dict[str, Any]] = None, @@ -208,6 +218,8 @@ async def list_async( List Purchase Orders :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param pass_through: Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads @@ -229,6 +241,8 @@ async def list_async( request = models.AccountingPurchaseOrdersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, pass_through=pass_through, @@ -294,6 +308,8 @@ def next_func() -> Optional[models.AccountingPurchaseOrdersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, pass_through=pass_through, @@ -361,6 +377,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, po_number: OptionalNullable[str] = UNSET, reference: OptionalNullable[str] = UNSET, @@ -424,6 +442,8 @@ def create( Create Purchase Order :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param po_number: A PO Number uniquely identifies a purchase order and is generally defined by the buyer. :param reference: Optional purchase order reference. @@ -469,6 +489,8 @@ def create( request = models.AccountingPurchaseOrdersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, purchase_order=models.PurchaseOrderInput( po_number=po_number, @@ -622,6 +644,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, po_number: OptionalNullable[str] = UNSET, reference: OptionalNullable[str] = UNSET, @@ -685,6 +709,8 @@ async def create_async( Create Purchase Order :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param po_number: A PO Number uniquely identifies a purchase order and is generally defined by the buyer. :param reference: Optional purchase order reference. @@ -730,6 +756,8 @@ async def create_async( request = models.AccountingPurchaseOrdersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, purchase_order=models.PurchaseOrderInput( po_number=po_number, @@ -883,6 +911,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -895,6 +925,8 @@ def get( Get Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -912,6 +944,8 @@ def get( request = models.AccountingPurchaseOrdersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1017,6 +1051,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1029,6 +1065,8 @@ async def get_async( Get Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1046,6 +1084,8 @@ async def get_async( request = models.AccountingPurchaseOrdersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1151,6 +1191,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, po_number: OptionalNullable[str] = UNSET, @@ -1215,6 +1257,8 @@ def update( Update Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param po_number: A PO Number uniquely identifies a purchase order and is generally defined by the buyer. @@ -1261,6 +1305,8 @@ def update( request = models.AccountingPurchaseOrdersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, purchase_order=models.PurchaseOrderInput( @@ -1415,6 +1461,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, po_number: OptionalNullable[str] = UNSET, @@ -1479,6 +1527,8 @@ async def update_async( Update Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param po_number: A PO Number uniquely identifies a purchase order and is generally defined by the buyer. @@ -1525,6 +1575,8 @@ async def update_async( request = models.AccountingPurchaseOrdersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, purchase_order=models.PurchaseOrderInput( @@ -1679,6 +1731,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1691,6 +1745,8 @@ def delete( Delete Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1708,6 +1764,8 @@ def delete( request = models.AccountingPurchaseOrdersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1813,6 +1871,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1825,6 +1885,8 @@ async def delete_async( Delete Purchase Order :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1842,6 +1904,8 @@ async def delete_async( request = models.AccountingPurchaseOrdersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/sessions.py b/src/apideck_unify/sessions.py index bedb24e4..4a84b6d6 100644 --- a/src/apideck_unify/sessions.py +++ b/src/apideck_unify/sessions.py @@ -3,16 +3,18 @@ from .basesdk import BaseSDK from apideck_unify import models, utils from apideck_unify._hooks import HookContext -from apideck_unify.types import BaseModel, OptionalNullable, UNSET +from apideck_unify.types import OptionalNullable, UNSET from apideck_unify.utils import get_security_from_env -from typing import Any, Mapping, Optional, Union, cast +from typing import Any, Mapping, Optional, Union class Sessions(BaseSDK): def create( self, *, - request: Optional[Union[models.Session, models.SessionTypedDict]] = None, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, + session: Optional[Union[models.Session, models.SessionTypedDict]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -26,7 +28,9 @@ def create( Note: This is a short lived token that will expire after 1 hour (TTL: 3600). - :param request: The request object to send. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application + :param session: Additional redirect uri and/or consumer metadata :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -40,9 +44,11 @@ def create( if server_url is not None: base_url = server_url - if not isinstance(request, BaseModel): - request = utils.unmarshal(request, Optional[models.Session]) - request = cast(Optional[models.Session], request) + request = models.VaultSessionsCreateRequest( + consumer_id=consumer_id, + app_id=app_id, + session=utils.get_pydantic_model(session, Optional[models.Session]), + ) req = self._build_request( method="POST", @@ -62,7 +68,7 @@ def create( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, True, "json", Optional[models.Session] + request.session, False, True, "json", Optional[models.Session] ), timeout_ms=timeout_ms, ) @@ -147,7 +153,9 @@ def create( async def create_async( self, *, - request: Optional[Union[models.Session, models.SessionTypedDict]] = None, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, + session: Optional[Union[models.Session, models.SessionTypedDict]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -161,7 +169,9 @@ async def create_async( Note: This is a short lived token that will expire after 1 hour (TTL: 3600). - :param request: The request object to send. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application + :param session: Additional redirect uri and/or consumer metadata :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -175,9 +185,11 @@ async def create_async( if server_url is not None: base_url = server_url - if not isinstance(request, BaseModel): - request = utils.unmarshal(request, Optional[models.Session]) - request = cast(Optional[models.Session], request) + request = models.VaultSessionsCreateRequest( + consumer_id=consumer_id, + app_id=app_id, + session=utils.get_pydantic_model(session, Optional[models.Session]), + ) req = self._build_request_async( method="POST", @@ -197,7 +209,7 @@ async def create_async( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, True, "json", Optional[models.Session] + request.session, False, True, "json", Optional[models.Session] ), timeout_ms=timeout_ms, ) diff --git a/src/apideck_unify/sharedlinks.py b/src/apideck_unify/sharedlinks.py index bae2c690..1b5fb217 100644 --- a/src/apideck_unify/sharedlinks.py +++ b/src/apideck_unify/sharedlinks.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List SharedLinks :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.FileStorageSharedLinksAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.FileStorageSharedLinksAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List SharedLinks :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.FileStorageSharedLinksAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.FileStorageSharedLinksAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -341,6 +357,8 @@ def create( *, target_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, download_url: OptionalNullable[str] = UNSET, scope: OptionalNullable[models.Scope] = UNSET, @@ -359,6 +377,8 @@ def create( :param target_id: The ID of the file or folder to link. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param download_url: The URL that can be used to download the file. :param scope: The scope of the shared link. @@ -379,6 +399,8 @@ def create( request = models.FileStorageSharedLinksAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, shared_link=models.SharedLinkInput( download_url=download_url, @@ -496,6 +518,8 @@ async def create_async( *, target_id: Nullable[str], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, download_url: OptionalNullable[str] = UNSET, scope: OptionalNullable[models.Scope] = UNSET, @@ -514,6 +538,8 @@ async def create_async( :param target_id: The ID of the file or folder to link. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param download_url: The URL that can be used to download the file. :param scope: The scope of the shared link. @@ -534,6 +560,8 @@ async def create_async( request = models.FileStorageSharedLinksAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, shared_link=models.SharedLinkInput( download_url=download_url, @@ -650,6 +678,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -663,6 +693,8 @@ def get( Get Shared Link :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -681,6 +713,8 @@ def get( request = models.FileStorageSharedLinksOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -787,6 +821,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -800,6 +836,8 @@ async def get_async( Get Shared Link :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -818,6 +856,8 @@ async def get_async( request = models.FileStorageSharedLinksOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -925,6 +965,8 @@ def update( *, id: str, target_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, download_url: OptionalNullable[str] = UNSET, @@ -944,6 +986,8 @@ def update( :param id: ID of the record you are acting upon. :param target_id: The ID of the file or folder to link. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param download_url: The URL that can be used to download the file. @@ -965,6 +1009,8 @@ def update( request = models.FileStorageSharedLinksUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, shared_link=models.SharedLinkInput( @@ -1083,6 +1129,8 @@ async def update_async( *, id: str, target_id: Nullable[str], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, download_url: OptionalNullable[str] = UNSET, @@ -1102,6 +1150,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param target_id: The ID of the file or folder to link. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param download_url: The URL that can be used to download the file. @@ -1123,6 +1173,8 @@ async def update_async( request = models.FileStorageSharedLinksUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, shared_link=models.SharedLinkInput( @@ -1240,6 +1292,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1252,6 +1306,8 @@ def delete( Delete Shared Link :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1269,6 +1325,8 @@ def delete( request = models.FileStorageSharedLinksDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1374,6 +1432,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1386,6 +1446,8 @@ async def delete_async( Delete Shared Link :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1403,6 +1465,8 @@ async def delete_async( request = models.FileStorageSharedLinksDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/stores.py b/src/apideck_unify/stores.py index c0e52370..f4caa231 100644 --- a/src/apideck_unify/stores.py +++ b/src/apideck_unify/stores.py @@ -12,6 +12,8 @@ class Stores(BaseSDK): def get( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -24,6 +26,8 @@ def get( Get Store + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -41,6 +45,8 @@ def get( base_url = server_url request = models.EcommerceStoresOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -146,6 +152,8 @@ def get( async def get_async( self, *, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -158,6 +166,8 @@ async def get_async( Get Store + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -175,6 +185,8 @@ async def get_async( base_url = server_url request = models.EcommerceStoresOneRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, diff --git a/src/apideck_unify/subsidiaries.py b/src/apideck_unify/subsidiaries.py index 469fe777..45c635a3 100644 --- a/src/apideck_unify/subsidiaries.py +++ b/src/apideck_unify/subsidiaries.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -28,6 +30,8 @@ def list( List Subsidiaries :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -47,6 +51,8 @@ def list( request = models.AccountingSubsidiariesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -108,6 +114,8 @@ def next_func() -> Optional[models.AccountingSubsidiariesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -173,6 +181,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -187,6 +197,8 @@ async def list_async( List Subsidiaries :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -206,6 +218,8 @@ async def list_async( request = models.AccountingSubsidiariesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -267,6 +281,8 @@ def next_func() -> Optional[models.AccountingSubsidiariesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -332,6 +348,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: OptionalNullable[str] = UNSET, @@ -350,6 +368,8 @@ def create( Create Subsidiary :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the company. @@ -371,6 +391,8 @@ def create( request = models.AccountingSubsidiariesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, subsidiary=models.SubsidiaryInput( parent_id=parent_id, @@ -487,6 +509,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: OptionalNullable[str] = UNSET, @@ -505,6 +529,8 @@ async def create_async( Create Subsidiary :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the company. @@ -526,6 +552,8 @@ async def create_async( request = models.AccountingSubsidiariesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, subsidiary=models.SubsidiaryInput( parent_id=parent_id, @@ -642,6 +670,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -655,6 +685,8 @@ def get( Get Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -673,6 +705,8 @@ def get( request = models.AccountingSubsidiariesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -779,6 +813,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -792,6 +828,8 @@ async def get_async( Get Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -810,6 +848,8 @@ async def get_async( request = models.AccountingSubsidiariesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -916,6 +956,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -935,6 +977,8 @@ def update( Update Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -957,6 +1001,8 @@ def update( request = models.AccountingSubsidiariesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, subsidiary=models.SubsidiaryInput( @@ -1074,6 +1120,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1093,6 +1141,8 @@ async def update_async( Update Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1115,6 +1165,8 @@ async def update_async( request = models.AccountingSubsidiariesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, subsidiary=models.SubsidiaryInput( @@ -1232,6 +1284,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1244,6 +1298,8 @@ def delete( Delete Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1261,6 +1317,8 @@ def delete( request = models.AccountingSubsidiariesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1366,6 +1424,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1378,6 +1438,8 @@ async def delete_async( Delete Subsidiary :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1395,6 +1457,8 @@ async def delete_async( request = models.AccountingSubsidiariesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/suppliers.py b/src/apideck_unify/suppliers.py index 7ba779b7..f972fcbb 100644 --- a/src/apideck_unify/suppliers.py +++ b/src/apideck_unify/suppliers.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -35,6 +37,8 @@ def list( List Suppliers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -57,6 +61,8 @@ def list( request = models.AccountingSuppliersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -121,6 +127,8 @@ def next_func() -> Optional[models.AccountingSuppliersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -189,6 +197,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -210,6 +220,8 @@ async def list_async( List Suppliers :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -232,6 +244,8 @@ async def list_async( request = models.AccountingSuppliersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -296,6 +310,8 @@ def next_func() -> Optional[models.AccountingSuppliersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -364,6 +380,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: OptionalNullable[str] = UNSET, display_name: OptionalNullable[str] = UNSET, @@ -421,6 +439,8 @@ def create( Create Supplier :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: Display ID :param display_name: Display name @@ -464,6 +484,8 @@ def create( request = models.AccountingSuppliersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, supplier=models.SupplierInput( display_id=display_id, @@ -616,6 +638,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, display_id: OptionalNullable[str] = UNSET, display_name: OptionalNullable[str] = UNSET, @@ -673,6 +697,8 @@ async def create_async( Create Supplier :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param display_id: Display ID :param display_name: Display name @@ -716,6 +742,8 @@ async def create_async( request = models.AccountingSuppliersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, supplier=models.SupplierInput( display_id=display_id, @@ -868,6 +896,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -881,6 +911,8 @@ def get( Get Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -899,6 +931,8 @@ def get( request = models.AccountingSuppliersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1005,6 +1039,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -1018,6 +1054,8 @@ async def get_async( Get Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -1036,6 +1074,8 @@ async def get_async( request = models.AccountingSuppliersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1142,6 +1182,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: OptionalNullable[str] = UNSET, @@ -1200,6 +1242,8 @@ def update( Update Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: Display ID @@ -1244,6 +1288,8 @@ def update( request = models.AccountingSuppliersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, supplier=models.SupplierInput( @@ -1397,6 +1443,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, display_id: OptionalNullable[str] = UNSET, @@ -1455,6 +1503,8 @@ async def update_async( Update Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param display_id: Display ID @@ -1499,6 +1549,8 @@ async def update_async( request = models.AccountingSuppliersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, supplier=models.SupplierInput( @@ -1652,6 +1704,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1664,6 +1718,8 @@ def delete( Delete Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1681,6 +1737,8 @@ def delete( request = models.AccountingSuppliersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1786,6 +1844,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1798,6 +1858,8 @@ async def delete_async( Delete Supplier :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1815,6 +1877,8 @@ async def delete_async( request = models.AccountingSuppliersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/taxrates.py b/src/apideck_unify/taxrates.py index 743886f1..5c007e47 100644 --- a/src/apideck_unify/taxrates.py +++ b/src/apideck_unify/taxrates.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -33,6 +35,8 @@ def list( :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -54,6 +58,8 @@ def list( request = models.AccountingTaxRatesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -117,6 +123,8 @@ def next_func() -> Optional[models.AccountingTaxRatesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -184,6 +192,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -203,6 +213,8 @@ async def list_async( :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -224,6 +236,8 @@ async def list_async( request = models.AccountingTaxRatesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -287,6 +301,8 @@ def next_func() -> Optional[models.AccountingTaxRatesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -354,6 +370,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, id: OptionalNullable[str] = UNSET, name: Optional[str] = None, @@ -392,6 +410,8 @@ def create( Create Tax Rate :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param id: ID assigned to identify this tax rate. :param name: Name assigned to identify this tax rate. @@ -425,6 +445,8 @@ def create( request = models.AccountingTaxRatesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, tax_rate=models.TaxRateInput( id=id, @@ -559,6 +581,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, id: OptionalNullable[str] = UNSET, name: Optional[str] = None, @@ -597,6 +621,8 @@ async def create_async( Create Tax Rate :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param id: ID assigned to identify this tax rate. :param name: Name assigned to identify this tax rate. @@ -630,6 +656,8 @@ async def create_async( request = models.AccountingTaxRatesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, tax_rate=models.TaxRateInput( id=id, @@ -764,6 +792,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -778,6 +808,8 @@ def get( :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -796,6 +828,8 @@ def get( request = models.AccountingTaxRatesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -902,6 +936,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -916,6 +952,8 @@ async def get_async( :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -934,6 +972,8 @@ async def get_async( request = models.AccountingTaxRatesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1040,6 +1080,8 @@ def update( self, *, id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, id: OptionalNullable[str] = UNSET, @@ -1079,6 +1121,8 @@ def update( Update Tax Rate :param id_param: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param id: ID assigned to identify this tax rate. @@ -1113,6 +1157,8 @@ def update( request = models.AccountingTaxRatesUpdateRequest( id_param=id_param, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, tax_rate=models.TaxRateInput( @@ -1248,6 +1294,8 @@ async def update_async( self, *, id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, id: OptionalNullable[str] = UNSET, @@ -1287,6 +1335,8 @@ async def update_async( Update Tax Rate :param id_param: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param id: ID assigned to identify this tax rate. @@ -1321,6 +1371,8 @@ async def update_async( request = models.AccountingTaxRatesUpdateRequest( id_param=id_param, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, tax_rate=models.TaxRateInput( @@ -1456,6 +1508,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1468,6 +1522,8 @@ def delete( Delete Tax Rate :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1485,6 +1541,8 @@ def delete( request = models.AccountingTaxRatesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1590,6 +1648,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1602,6 +1662,8 @@ async def delete_async( Delete Tax Rate :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1619,6 +1681,8 @@ async def delete_async( request = models.AccountingTaxRatesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/timeoffrequests.py b/src/apideck_unify/timeoffrequests.py index 2754c0b0..cd3a4348 100644 --- a/src/apideck_unify/timeoffrequests.py +++ b/src/apideck_unify/timeoffrequests.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -32,6 +34,8 @@ def list( List Time Off Requests :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -53,6 +57,8 @@ def list( request = models.HrisTimeOffRequestsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -118,6 +124,8 @@ def next_func() -> Optional[models.HrisTimeOffRequestsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -185,6 +193,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -203,6 +213,8 @@ async def list_async( List Time Off Requests :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -224,6 +236,8 @@ async def list_async( request = models.HrisTimeOffRequestsAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -289,6 +303,8 @@ def next_func() -> Optional[models.HrisTimeOffRequestsAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -356,6 +372,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, employee_id: OptionalNullable[str] = UNSET, policy_id: OptionalNullable[str] = UNSET, @@ -384,6 +402,8 @@ def create( Create Time Off Request :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param employee_id: ID of the employee :param policy_id: ID of the policy @@ -415,6 +435,8 @@ def create( request = models.HrisTimeOffRequestsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, time_off_request=models.TimeOffRequestInput( employee_id=employee_id, @@ -545,6 +567,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, employee_id: OptionalNullable[str] = UNSET, policy_id: OptionalNullable[str] = UNSET, @@ -573,6 +597,8 @@ async def create_async( Create Time Off Request :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param employee_id: ID of the employee :param policy_id: ID of the policy @@ -604,6 +630,8 @@ async def create_async( request = models.HrisTimeOffRequestsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, time_off_request=models.TimeOffRequestInput( employee_id=employee_id, @@ -735,6 +763,8 @@ def get( *, id: str, employee_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -749,6 +779,8 @@ def get( :param id: ID of the record you are acting upon. :param employee_id: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -767,6 +799,8 @@ def get( request = models.HrisTimeOffRequestsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -875,6 +909,8 @@ async def get_async( *, id: str, employee_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -889,6 +925,8 @@ async def get_async( :param id: ID of the record you are acting upon. :param employee_id: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -907,6 +945,8 @@ async def get_async( request = models.HrisTimeOffRequestsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1015,6 +1055,8 @@ def update( *, id: str, employee_id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, employee_id: OptionalNullable[str] = UNSET, @@ -1045,6 +1087,8 @@ def update( :param id: ID of the record you are acting upon. :param employee_id_param: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param employee_id: ID of the employee @@ -1077,6 +1121,8 @@ def update( request = models.HrisTimeOffRequestsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee_id_param=employee_id_param, @@ -1210,6 +1256,8 @@ async def update_async( *, id: str, employee_id_param: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, employee_id: OptionalNullable[str] = UNSET, @@ -1240,6 +1288,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param employee_id_param: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param employee_id: ID of the employee @@ -1272,6 +1322,8 @@ async def update_async( request = models.HrisTimeOffRequestsUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee_id_param=employee_id_param, @@ -1405,6 +1457,8 @@ def delete( *, id: str, employee_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1418,6 +1472,8 @@ def delete( :param id: ID of the record you are acting upon. :param employee_id: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1435,6 +1491,8 @@ def delete( request = models.HrisTimeOffRequestsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee_id=employee_id, @@ -1542,6 +1600,8 @@ async def delete_async( *, id: str, employee_id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1555,6 +1615,8 @@ async def delete_async( :param id: ID of the record you are acting upon. :param employee_id: ID of the employee you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1572,6 +1634,8 @@ async def delete_async( request = models.HrisTimeOffRequestsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, employee_id=employee_id, diff --git a/src/apideck_unify/trackingcategories.py b/src/apideck_unify/trackingcategories.py index e1f34b28..e836019e 100644 --- a/src/apideck_unify/trackingcategories.py +++ b/src/apideck_unify/trackingcategories.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List Tracking Categories :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.AccountingTrackingCategoriesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.AccountingTrackingCategoriesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List Tracking Categories :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.AccountingTrackingCategoriesAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.AccountingTrackingCategoriesAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -340,6 +356,8 @@ def create( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: Optional[str] = None, @@ -365,6 +383,8 @@ def create( Create Tracking Category :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the tracking category. @@ -388,6 +408,8 @@ def create( request = models.AccountingTrackingCategoriesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, tracking_category=models.TrackingCategoryInput( parent_id=parent_id, @@ -512,6 +534,8 @@ async def create_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, name: Optional[str] = None, @@ -537,6 +561,8 @@ async def create_async( Create Tracking Category :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: A unique identifier for an object. :param name: The name of the tracking category. @@ -560,6 +586,8 @@ async def create_async( request = models.AccountingTrackingCategoriesAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, tracking_category=models.TrackingCategoryInput( parent_id=parent_id, @@ -684,6 +712,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -697,6 +727,8 @@ def get( Get Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -715,6 +747,8 @@ def get( request = models.AccountingTrackingCategoriesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -821,6 +855,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -834,6 +870,8 @@ async def get_async( Get Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -852,6 +890,8 @@ async def get_async( request = models.AccountingTrackingCategoriesOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -958,6 +998,8 @@ def update( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -984,6 +1026,8 @@ def update( Update Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1008,6 +1052,8 @@ def update( request = models.AccountingTrackingCategoriesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, tracking_category=models.TrackingCategoryInput( @@ -1133,6 +1179,8 @@ async def update_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1159,6 +1207,8 @@ async def update_async( Update Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: A unique identifier for an object. @@ -1183,6 +1233,8 @@ async def update_async( request = models.AccountingTrackingCategoriesUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, tracking_category=models.TrackingCategoryInput( @@ -1308,6 +1360,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1320,6 +1374,8 @@ def delete( Delete Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1337,6 +1393,8 @@ def delete( request = models.AccountingTrackingCategoriesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1442,6 +1500,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1454,6 +1514,8 @@ async def delete_async( Delete Tracking Category :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1471,6 +1533,8 @@ async def delete_async( request = models.AccountingTrackingCategoriesDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/uploadsessions.py b/src/apideck_unify/uploadsessions.py index 6265bc27..a278e961 100644 --- a/src/apideck_unify/uploadsessions.py +++ b/src/apideck_unify/uploadsessions.py @@ -16,6 +16,8 @@ def create( parent_folder_id: str, size: Nullable[int], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, drive_id: Optional[str] = None, pass_through: Optional[ @@ -34,6 +36,8 @@ def create( :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. :param size: The size of the file in bytes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param drive_id: ID of the drive to upload to. :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -54,6 +58,8 @@ def create( request = models.FileStorageUploadSessionsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, create_upload_session_request=models.CreateUploadSessionRequest( name=name, @@ -177,6 +183,8 @@ async def create_async( parent_folder_id: str, size: Nullable[int], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, drive_id: Optional[str] = None, pass_through: Optional[ @@ -195,6 +203,8 @@ async def create_async( :param parent_folder_id: The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas. :param size: The size of the file in bytes :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param drive_id: ID of the drive to upload to. :param pass_through: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. @@ -215,6 +225,8 @@ async def create_async( request = models.FileStorageUploadSessionsAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, create_upload_session_request=models.CreateUploadSessionRequest( name=name, @@ -335,6 +347,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -348,6 +362,8 @@ def get( Get Upload Session. Use the `part_size` to split your file into parts. Upload the parts to the [Upload part of File](#operation/uploadSessionsUpload) endpoint. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload). :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -368,6 +384,8 @@ def get( request = models.FileStorageUploadSessionsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -474,6 +492,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -487,6 +507,8 @@ async def get_async( Get Upload Session. Use the `part_size` to split your file into parts. Upload the parts to the [Upload part of File](#operation/uploadSessionsUpload) endpoint. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload). :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -507,6 +529,8 @@ async def get_async( request = models.FileStorageUploadSessionsOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -613,6 +637,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -625,6 +651,8 @@ def delete( Abort Upload Session. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload). :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -642,6 +670,8 @@ def delete( request = models.FileStorageUploadSessionsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -747,6 +777,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -759,6 +791,8 @@ async def delete_async( Abort Upload Session. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload). :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -776,6 +810,8 @@ async def delete_async( request = models.FileStorageUploadSessionsDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -882,6 +918,8 @@ def finish( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, digest: Optional[str] = None, request_body: Optional[ @@ -901,6 +939,8 @@ def finish( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param digest: The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) :param request_body: @@ -922,6 +962,8 @@ def finish( request = models.FileStorageUploadSessionsFinishRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, digest=digest, request_body=utils.get_pydantic_model( @@ -1039,6 +1081,8 @@ async def finish_async( *, id: str, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, digest: Optional[str] = None, request_body: Optional[ @@ -1058,6 +1102,8 @@ async def finish_async( :param id: ID of the record you are acting upon. :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param digest: The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) :param request_body: @@ -1079,6 +1125,8 @@ async def finish_async( request = models.FileStorageUploadSessionsFinishRequest( id=id, raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, digest=digest, request_body=utils.get_pydantic_model( diff --git a/src/apideck_unify/users.py b/src/apideck_unify/users.py index 8b6bfa7e..4ca5c5d1 100644 --- a/src/apideck_unify/users.py +++ b/src/apideck_unify/users.py @@ -14,6 +14,8 @@ def list( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -29,6 +31,8 @@ def list( List users :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -49,6 +53,8 @@ def list( request = models.CrmUsersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -111,6 +117,8 @@ def next_func() -> Optional[models.CrmUsersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -177,6 +185,8 @@ async def list_async( self, *, raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, @@ -192,6 +202,8 @@ async def list_async( List users :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 @@ -212,6 +224,8 @@ async def list_async( request = models.CrmUsersAllRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, @@ -274,6 +288,8 @@ def next_func() -> Optional[models.CrmUsersAllResponse]: return self.list( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, cursor=next_cursor, limit=limit, @@ -341,6 +357,8 @@ def create( *, emails: Union[List[models.Email], List[models.EmailTypedDict]], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, username: OptionalNullable[str] = UNSET, @@ -376,6 +394,8 @@ def create( :param emails: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: The parent user id :param username: The username of the user @@ -409,6 +429,8 @@ def create( request = models.CrmUsersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, user=models.UserInput( parent_id=parent_id, @@ -543,6 +565,8 @@ async def create_async( *, emails: Union[List[models.Email], List[models.EmailTypedDict]], raw: Optional[bool] = False, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, parent_id: OptionalNullable[str] = UNSET, username: OptionalNullable[str] = UNSET, @@ -578,6 +602,8 @@ async def create_async( :param emails: :param raw: Include raw response. Mostly used for debugging purposes + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param parent_id: The parent user id :param username: The username of the user @@ -611,6 +637,8 @@ async def create_async( request = models.CrmUsersAddRequest( raw=raw, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, user=models.UserInput( parent_id=parent_id, @@ -744,6 +772,8 @@ def get( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -757,6 +787,8 @@ def get( Get user :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -775,6 +807,8 @@ def get( request = models.CrmUsersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -881,6 +915,8 @@ async def get_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, fields: OptionalNullable[str] = UNSET, @@ -894,6 +930,8 @@ async def get_async( Get user :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. @@ -912,6 +950,8 @@ async def get_async( request = models.CrmUsersOneRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, fields=fields, @@ -1019,6 +1059,8 @@ def update( *, id: str, emails: Union[List[models.Email], List[models.EmailTypedDict]], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1055,6 +1097,8 @@ def update( :param id: ID of the record you are acting upon. :param emails: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: The parent user id @@ -1089,6 +1133,8 @@ def update( request = models.CrmUsersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, user=models.UserInput( @@ -1224,6 +1270,8 @@ async def update_async( *, id: str, emails: Union[List[models.Email], List[models.EmailTypedDict]], + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, parent_id: OptionalNullable[str] = UNSET, @@ -1260,6 +1308,8 @@ async def update_async( :param id: ID of the record you are acting upon. :param emails: + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param parent_id: The parent user id @@ -1294,6 +1344,8 @@ async def update_async( request = models.CrmUsersUpdateRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, user=models.UserInput( @@ -1428,6 +1480,8 @@ def delete( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1440,6 +1494,8 @@ def delete( Delete user :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1457,6 +1513,8 @@ def delete( request = models.CrmUsersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) @@ -1562,6 +1620,8 @@ async def delete_async( self, *, id: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, service_id: Optional[str] = None, raw: Optional[bool] = False, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1574,6 +1634,8 @@ async def delete_async( Delete user :param id: ID of the record you are acting upon. + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param raw: Include raw response. Mostly used for debugging purposes :param retries: Override the default retry configuration for this method @@ -1591,6 +1653,8 @@ async def delete_async( request = models.CrmUsersDeleteRequest( id=id, + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, raw=raw, ) diff --git a/src/apideck_unify/validateconnection.py b/src/apideck_unify/validateconnection.py index c9d25562..80867a4a 100644 --- a/src/apideck_unify/validateconnection.py +++ b/src/apideck_unify/validateconnection.py @@ -14,6 +14,8 @@ def state( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, request_body: Optional[ Union[ models.VaultValidateConnectionStateRequestBody, @@ -37,6 +39,8 @@ def state( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param request_body: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -52,6 +56,8 @@ def state( base_url = server_url request = models.VaultValidateConnectionStateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, request_body=utils.get_pydantic_model( @@ -168,6 +174,8 @@ async def state_async( *, service_id: str, unified_api: str, + consumer_id: Optional[str] = None, + app_id: Optional[str] = None, request_body: Optional[ Union[ models.VaultValidateConnectionStateRequestBody, @@ -191,6 +199,8 @@ async def state_async( :param service_id: Service ID of the resource to return :param unified_api: Unified API + :param consumer_id: ID of the consumer which you want to get or push data from + :param app_id: The ID of your Unify application :param request_body: :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -206,6 +216,8 @@ async def state_async( base_url = server_url request = models.VaultValidateConnectionStateRequest( + consumer_id=consumer_id, + app_id=app_id, service_id=service_id, unified_api=unified_api, request_body=utils.get_pydantic_model( diff --git a/src/apideck_unify/webhooks.py b/src/apideck_unify/webhooks.py index 87ce7ec8..a6c724a8 100644 --- a/src/apideck_unify/webhooks.py +++ b/src/apideck_unify/webhooks.py @@ -13,6 +13,7 @@ class Webhooks(BaseSDK): def list( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -24,6 +25,7 @@ def list( List all webhook subscriptions + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param retries: Override the default retry configuration for this method @@ -40,6 +42,7 @@ def list( base_url = server_url request = models.WebhookWebhooksAllRequest( + app_id=app_id, cursor=cursor, limit=limit, ) @@ -97,6 +100,7 @@ def next_func() -> Optional[models.WebhookWebhooksAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, retries=retries, @@ -159,6 +163,7 @@ def next_func() -> Optional[models.WebhookWebhooksAllResponse]: async def list_async( self, *, + app_id: Optional[str] = None, cursor: OptionalNullable[str] = UNSET, limit: Optional[int] = 20, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -170,6 +175,7 @@ async def list_async( List all webhook subscriptions + :param app_id: The ID of your Unify application :param cursor: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. :param limit: Number of results to return. Minimum 1, Maximum 200, Default 20 :param retries: Override the default retry configuration for this method @@ -186,6 +192,7 @@ async def list_async( base_url = server_url request = models.WebhookWebhooksAllRequest( + app_id=app_id, cursor=cursor, limit=limit, ) @@ -243,6 +250,7 @@ def next_func() -> Optional[models.WebhookWebhooksAllResponse]: next_cursor = next_cursor[0] return self.list( + app_id=app_id, cursor=next_cursor, limit=limit, retries=retries, @@ -309,6 +317,7 @@ def create( status: models.Status, delivery_url: str, events: List[models.WebhookEventType], + app_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -323,6 +332,7 @@ def create( :param status: The status of the webhook. :param delivery_url: The delivery url of the webhook endpoint. :param events: The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + :param app_id: The ID of your Unify application :param description: A description of the object. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -337,12 +347,15 @@ def create( if server_url is not None: base_url = server_url - request = models.CreateWebhookRequest( - description=description, - unified_api=unified_api, - status=status, - delivery_url=delivery_url, - events=events, + request = models.WebhookWebhooksAddRequest( + app_id=app_id, + create_webhook_request=models.CreateWebhookRequest( + description=description, + unified_api=unified_api, + status=status, + delivery_url=delivery_url, + events=events, + ), ) req = self._build_request( @@ -362,7 +375,11 @@ def create( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.CreateWebhookRequest + request.create_webhook_request, + False, + False, + "json", + models.CreateWebhookRequest, ), timeout_ms=timeout_ms, ) @@ -451,6 +468,7 @@ async def create_async( status: models.Status, delivery_url: str, events: List[models.WebhookEventType], + app_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -465,6 +483,7 @@ async def create_async( :param status: The status of the webhook. :param delivery_url: The delivery url of the webhook endpoint. :param events: The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + :param app_id: The ID of your Unify application :param description: A description of the object. :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -479,12 +498,15 @@ async def create_async( if server_url is not None: base_url = server_url - request = models.CreateWebhookRequest( - description=description, - unified_api=unified_api, - status=status, - delivery_url=delivery_url, - events=events, + request = models.WebhookWebhooksAddRequest( + app_id=app_id, + create_webhook_request=models.CreateWebhookRequest( + description=description, + unified_api=unified_api, + status=status, + delivery_url=delivery_url, + events=events, + ), ) req = self._build_request_async( @@ -504,7 +526,11 @@ async def create_async( ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( - request, False, False, "json", models.CreateWebhookRequest + request.create_webhook_request, + False, + False, + "json", + models.CreateWebhookRequest, ), timeout_ms=timeout_ms, ) @@ -590,6 +616,7 @@ def get( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -600,6 +627,7 @@ def get( Get the webhook subscription details :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -615,6 +643,7 @@ def get( request = models.WebhookWebhooksOneRequest( id=id, + app_id=app_id, ) req = self._build_request( @@ -717,6 +746,7 @@ async def get_async( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -727,6 +757,7 @@ async def get_async( Get the webhook subscription details :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -742,6 +773,7 @@ async def get_async( request = models.WebhookWebhooksOneRequest( id=id, + app_id=app_id, ) req = self._build_request_async( @@ -844,6 +876,7 @@ def update( self, *, id: str, + app_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, status: Optional[models.Status] = None, delivery_url: Optional[str] = None, @@ -858,6 +891,7 @@ def update( Update a webhook subscription :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param description: A description of the object. :param status: The status of the webhook. :param delivery_url: The delivery url of the webhook endpoint. @@ -877,6 +911,7 @@ def update( request = models.WebhookWebhooksUpdateRequest( id=id, + app_id=app_id, update_webhook_request=models.UpdateWebhookRequest( description=description, status=status, @@ -992,6 +1027,7 @@ async def update_async( self, *, id: str, + app_id: Optional[str] = None, description: OptionalNullable[str] = UNSET, status: Optional[models.Status] = None, delivery_url: Optional[str] = None, @@ -1006,6 +1042,7 @@ async def update_async( Update a webhook subscription :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param description: A description of the object. :param status: The status of the webhook. :param delivery_url: The delivery url of the webhook endpoint. @@ -1025,6 +1062,7 @@ async def update_async( request = models.WebhookWebhooksUpdateRequest( id=id, + app_id=app_id, update_webhook_request=models.UpdateWebhookRequest( description=description, status=status, @@ -1140,6 +1178,7 @@ def delete( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1150,6 +1189,7 @@ def delete( Delete a webhook subscription :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1165,6 +1205,7 @@ def delete( request = models.WebhookWebhooksDeleteRequest( id=id, + app_id=app_id, ) req = self._build_request( @@ -1267,6 +1308,7 @@ async def delete_async( self, *, id: str, + app_id: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1277,6 +1319,7 @@ async def delete_async( Delete a webhook subscription :param id: JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + :param app_id: The ID of your Unify application :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -1292,6 +1335,7 @@ async def delete_async( request = models.WebhookWebhooksDeleteRequest( id=id, + app_id=app_id, ) req = self._build_request_async(