yellowgrid-api-ts 3.2.168-dev.0 → 3.2.170-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -23
- package/.openapi-generator/VERSION +1 -1
- package/README.md +3 -53
- package/api.ts +5403 -3269
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/configuration.ts +21 -27
- package/dist/api.d.ts +4537 -1460
- package/dist/api.js +897 -3030
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +54 -1428
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/AdminUserModel.md +0 -2
- package/docs/BillingApi.md +1 -1
- package/docs/CRMApi.md +1 -121
- package/docs/Class3CXApi.md +1 -49
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -56
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditAccountEntity.md +0 -6
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortingApi.md +6 -6
- package/docs/OAuth20Api.md +1 -49
- package/docs/OrdersApi.md +1 -1
- package/docs/{PatchUpdateAccountCnameRequest.md → PatchSetTcxWizardCnameRequest.md} +3 -3
- package/docs/PortalAccountModel.md +2 -6
- package/docs/{CreateCrmNoteBody.md → PostAddAdminNoteRequest.md} +3 -3
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +1 -1
- package/docs/ProspectDTO.md +2 -4
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/RecordingBackupAzureModel.md +0 -2
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/GroupEnum.ts +44 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/dist/models/StatusEnum.d.ts +0 -18
- package/dist/models/StatusEnum.js +0 -20
- package/dist/src/apis/AccountsApi.d.ts +0 -258
- package/dist/src/apis/AccountsApi.js +0 -975
- package/dist/src/apis/CRMApi.d.ts +0 -26
- package/dist/src/apis/CRMApi.js +0 -122
- package/dist/src/apis/Class3CXApi.d.ts +0 -44
- package/dist/src/apis/Class3CXApi.js +0 -177
- package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +0 -446
- package/dist/src/apis/Class3CXInstallationWizardApi.js +0 -1740
- package/dist/src/apis/Class3CXInstallationsApi.d.ts +0 -253
- package/dist/src/apis/Class3CXInstallationsApi.js +0 -806
- package/dist/src/apis/Class3CXIntegrationsApi.d.ts +0 -102
- package/dist/src/apis/Class3CXIntegrationsApi.js +0 -386
- package/dist/src/apis/Class3CXMultiTenantApi.d.ts +0 -122
- package/dist/src/apis/Class3CXMultiTenantApi.js +0 -431
- package/dist/src/apis/MyPBXToolsApi.d.ts +0 -32
- package/dist/src/apis/MyPBXToolsApi.js +0 -136
- package/dist/src/apis/OAuth20Api.d.ts +0 -185
- package/dist/src/apis/OAuth20Api.js +0 -507
- package/dist/src/apis/OrdersApi.d.ts +0 -154
- package/dist/src/apis/OrdersApi.js +0 -512
- package/dist/src/apis/PricingApi.d.ts +0 -154
- package/dist/src/apis/PricingApi.js +0 -308
- package/dist/src/apis/ProductsApi.d.ts +0 -135
- package/dist/src/apis/ProductsApi.js +0 -531
- package/dist/src/apis/ProvisioningApi.d.ts +0 -112
- package/dist/src/apis/ProvisioningApi.js +0 -427
- package/dist/src/apis/SIPTrunksApi.d.ts +0 -315
- package/dist/src/apis/SIPTrunksApi.js +0 -1197
- package/dist/src/apis/SMSApi.d.ts +0 -30
- package/dist/src/apis/SMSApi.js +0 -130
- package/dist/src/apis/ServicesApi.d.ts +0 -81
- package/dist/src/apis/ServicesApi.js +0 -386
- package/dist/src/apis/ShippingApi.d.ts +0 -45
- package/dist/src/apis/ShippingApi.js +0 -179
- package/dist/src/apis/StockManagementApi.d.ts +0 -345
- package/dist/src/apis/StockManagementApi.js +0 -1293
- package/dist/src/apis/SystemApi.d.ts +0 -37
- package/dist/src/apis/SystemApi.js +0 -146
- package/dist/src/apis/TicketsApi.d.ts +0 -79
- package/dist/src/apis/TicketsApi.js +0 -360
- package/dist/src/apis/WebhooksApi.d.ts +0 -56
- package/dist/src/apis/WebhooksApi.js +0 -189
- package/dist/src/apis/index.d.ts +0 -21
- package/dist/src/apis/index.js +0 -39
- package/dist/src/index.d.ts +0 -3
- package/dist/src/index.js +0 -21
- package/dist/src/models/AbstractOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/AbstractOrderRequestDTO.js +0 -64
- package/dist/src/models/AccountContactEntity.d.ts +0 -104
- package/dist/src/models/AccountContactEntity.js +0 -73
- package/dist/src/models/AccountContactModel.d.ts +0 -104
- package/dist/src/models/AccountContactModel.js +0 -73
- package/dist/src/models/AccountContactRequestModel.d.ts +0 -80
- package/dist/src/models/AccountContactRequestModel.js +0 -65
- package/dist/src/models/AccountDetailedSummaryDTO.d.ts +0 -89
- package/dist/src/models/AccountDetailedSummaryDTO.js +0 -70
- package/dist/src/models/AccountRequestModel.d.ts +0 -128
- package/dist/src/models/AccountRequestModel.js +0 -81
- package/dist/src/models/AccountSummaryDTO.d.ts +0 -44
- package/dist/src/models/AccountSummaryDTO.js +0 -53
- package/dist/src/models/AccountsResponseModel.d.ts +0 -51
- package/dist/src/models/AccountsResponseModel.js +0 -56
- package/dist/src/models/AddressModel.d.ts +0 -110
- package/dist/src/models/AddressModel.js +0 -75
- package/dist/src/models/AddressRequestModel.d.ts +0 -50
- package/dist/src/models/AddressRequestModel.js +0 -55
- package/dist/src/models/AdminOrderRequestDTO.d.ts +0 -113
- package/dist/src/models/AdminOrderRequestDTO.js +0 -78
- package/dist/src/models/AdminUserModel.d.ts +0 -79
- package/dist/src/models/AdminUserModel.js +0 -72
- package/dist/src/models/AgentHoursGraphModel.d.ts +0 -51
- package/dist/src/models/AgentHoursGraphModel.js +0 -56
- package/dist/src/models/AgentHoursGraphMonthModel.d.ts +0 -38
- package/dist/src/models/AgentHoursGraphMonthModel.js +0 -51
- package/dist/src/models/ApiLogEntity.d.ts +0 -98
- package/dist/src/models/ApiLogEntity.js +0 -71
- package/dist/src/models/AreaCodeModel.d.ts +0 -38
- package/dist/src/models/AreaCodeModel.js +0 -51
- package/dist/src/models/AttachmentModel.d.ts +0 -56
- package/dist/src/models/AttachmentModel.js +0 -57
- package/dist/src/models/AttributeSetEnum.d.ts +0 -38
- package/dist/src/models/AttributeSetEnum.js +0 -51
- package/dist/src/models/AuditLogEntity.d.ts +0 -80
- package/dist/src/models/AuditLogEntity.js +0 -65
- package/dist/src/models/AuthCodeResponseModel.d.ts +0 -44
- package/dist/src/models/AuthCodeResponseModel.js +0 -53
- package/dist/src/models/BasicItemDTO.d.ts +0 -38
- package/dist/src/models/BasicItemDTO.js +0 -51
- package/dist/src/models/BasicProductDTO.d.ts +0 -38
- package/dist/src/models/BasicProductDTO.js +0 -51
- package/dist/src/models/BatchEntity.d.ts +0 -128
- package/dist/src/models/BatchEntity.js +0 -81
- package/dist/src/models/CallBarringModel.d.ts +0 -56
- package/dist/src/models/CallBarringModel.js +0 -57
- package/dist/src/models/ClientDetailsModel.d.ts +0 -68
- package/dist/src/models/ClientDetailsModel.js +0 -61
- package/dist/src/models/ClientModel.d.ts +0 -50
- package/dist/src/models/ClientModel.js +0 -55
- package/dist/src/models/CompanyContractModel.d.ts +0 -56
- package/dist/src/models/CompanyContractModel.js +0 -57
- package/dist/src/models/ContactInfoModel.d.ts +0 -56
- package/dist/src/models/ContactInfoModel.js +0 -57
- package/dist/src/models/ConversationModel.d.ts +0 -75
- package/dist/src/models/ConversationModel.js +0 -64
- package/dist/src/models/CourierPriceEntity.d.ts +0 -86
- package/dist/src/models/CourierPriceEntity.js +0 -67
- package/dist/src/models/CreditAccountEntity.d.ts +0 -152
- package/dist/src/models/CreditAccountEntity.js +0 -89
- package/dist/src/models/CrmContactDTO.d.ts +0 -68
- package/dist/src/models/CrmContactDTO.js +0 -61
- package/dist/src/models/CustomerInformationModel.d.ts +0 -68
- package/dist/src/models/CustomerInformationModel.js +0 -61
- package/dist/src/models/CustomerItemRequestDTO.d.ts +0 -81
- package/dist/src/models/CustomerItemRequestDTO.js +0 -66
- package/dist/src/models/CustomerOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/CustomerOrderRequestDTO.js +0 -64
- package/dist/src/models/CustomerPriceListEnum.d.ts +0 -38
- package/dist/src/models/CustomerPriceListEnum.js +0 -51
- package/dist/src/models/CustomerSummaryReportDTO.d.ts +0 -65
- package/dist/src/models/CustomerSummaryReportDTO.js +0 -62
- package/dist/src/models/DdiRangeRequestModel.d.ts +0 -44
- package/dist/src/models/DdiRangeRequestModel.js +0 -53
- package/dist/src/models/DdiRangesRequestModel.d.ts +0 -33
- package/dist/src/models/DdiRangesRequestModel.js +0 -50
- package/dist/src/models/DetailedItemRequestDTO.d.ts +0 -99
- package/dist/src/models/DetailedItemRequestDTO.js +0 -72
- package/dist/src/models/DetailedOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/DetailedOrderRequestDTO.js +0 -64
- package/dist/src/models/DivertRequestModel.d.ts +0 -38
- package/dist/src/models/DivertRequestModel.js +0 -51
- package/dist/src/models/DivertResponseModel.d.ts +0 -52
- package/dist/src/models/DivertResponseModel.js +0 -61
- package/dist/src/models/EdTechProClientEntity.d.ts +0 -56
- package/dist/src/models/EdTechProClientEntity.js +0 -57
- package/dist/src/models/EdTechProSchoolModel.d.ts +0 -104
- package/dist/src/models/EdTechProSchoolModel.js +0 -73
- package/dist/src/models/EdTechProSchoolsModel.d.ts +0 -51
- package/dist/src/models/EdTechProSchoolsModel.js +0 -56
- package/dist/src/models/EdTechProSetupModel.d.ts +0 -56
- package/dist/src/models/EdTechProSetupModel.js +0 -57
- package/dist/src/models/EventDTO.d.ts +0 -84
- package/dist/src/models/EventDTO.js +0 -73
- package/dist/src/models/EventRequestDTO.d.ts +0 -44
- package/dist/src/models/EventRequestDTO.js +0 -53
- package/dist/src/models/EventSubscriptionModel.d.ts +0 -38
- package/dist/src/models/EventSubscriptionModel.js +0 -51
- package/dist/src/models/EventTypeEnum.d.ts +0 -19
- package/dist/src/models/EventTypeEnum.js +0 -24
- package/dist/src/models/EventUpdateDTO.d.ts +0 -50
- package/dist/src/models/EventUpdateDTO.js +0 -55
- package/dist/src/models/EventUpdateEntity.d.ts +0 -56
- package/dist/src/models/EventUpdateEntity.js +0 -57
- package/dist/src/models/EventUpdateRequestDTO.d.ts +0 -44
- package/dist/src/models/EventUpdateRequestDTO.js +0 -53
- package/dist/src/models/FraudManagementModel.d.ts +0 -38
- package/dist/src/models/FraudManagementModel.js +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.js +0 -56
- package/dist/src/models/FreshdeskTicketEntity.d.ts +0 -68
- package/dist/src/models/FreshdeskTicketEntity.js +0 -61
- package/dist/src/models/FtpAccountsEntity.d.ts +0 -56
- package/dist/src/models/FtpAccountsEntity.js +0 -57
- package/dist/src/models/GenericFileModel.d.ts +0 -44
- package/dist/src/models/GenericFileModel.js +0 -53
- package/dist/src/models/GetGetPrice200Response.d.ts +0 -32
- package/dist/src/models/GetGetPrice200Response.js +0 -49
- package/dist/src/models/GetGetRecording200Response.d.ts +0 -32
- package/dist/src/models/GetGetRecording200Response.js +0 -49
- package/dist/src/models/HostingChangeResponseModel.d.ts +0 -64
- package/dist/src/models/HostingChangeResponseModel.js +0 -65
- package/dist/src/models/HostingRegionDTO.d.ts +0 -59
- package/dist/src/models/HostingRegionDTO.js +0 -68
- package/dist/src/models/InstanceAutoFailoverEntity.d.ts +0 -56
- package/dist/src/models/InstanceAutoFailoverEntity.js +0 -57
- package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +0 -50
- package/dist/src/models/InstanceDeletionScheduleEntity.js +0 -55
- package/dist/src/models/InstanceEntity.d.ts +0 -152
- package/dist/src/models/InstanceEntity.js +0 -89
- package/dist/src/models/InstanceFailoverEntity.d.ts +0 -92
- package/dist/src/models/InstanceFailoverEntity.js +0 -69
- package/dist/src/models/InstanceMonitoringEntity.d.ts +0 -44
- package/dist/src/models/InstanceMonitoringEntity.js +0 -53
- package/dist/src/models/InstanceMonitoringLogEntity.d.ts +0 -62
- package/dist/src/models/InstanceMonitoringLogEntity.js +0 -59
- package/dist/src/models/InstanceScheduledTasksEntity.d.ts +0 -62
- package/dist/src/models/InstanceScheduledTasksEntity.js +0 -59
- package/dist/src/models/InstanceTcxDetailsEntity.d.ts +0 -86
- package/dist/src/models/InstanceTcxDetailsEntity.js +0 -67
- package/dist/src/models/InstanceUserCredentialsEntity.d.ts +0 -56
- package/dist/src/models/InstanceUserCredentialsEntity.js +0 -57
- package/dist/src/models/ItemDTO.d.ts +0 -117
- package/dist/src/models/ItemDTO.js +0 -78
- package/dist/src/models/ItemDiscountEntity.d.ts +0 -77
- package/dist/src/models/ItemDiscountEntity.js +0 -70
- package/dist/src/models/ItemEntity.d.ts +0 -158
- package/dist/src/models/ItemEntity.js +0 -91
- package/dist/src/models/LinkedOrderEntity.d.ts +0 -38
- package/dist/src/models/LinkedOrderEntity.js +0 -51
- package/dist/src/models/MFARequiredModel.d.ts +0 -38
- package/dist/src/models/MFARequiredModel.js +0 -51
- package/dist/src/models/MonthlyUsageModel.d.ts +0 -38
- package/dist/src/models/MonthlyUsageModel.js +0 -51
- package/dist/src/models/MultiTenantChangeResponseModel.d.ts +0 -70
- package/dist/src/models/MultiTenantChangeResponseModel.js +0 -75
- package/dist/src/models/NavigationModel.d.ts +0 -50
- package/dist/src/models/NavigationModel.js +0 -55
- package/dist/src/models/OfflineInstancesEntity.d.ts +0 -56
- package/dist/src/models/OfflineInstancesEntity.js +0 -57
- package/dist/src/models/OrderEntity.d.ts +0 -374
- package/dist/src/models/OrderEntity.js +0 -163
- package/dist/src/models/OrderRequestModel.d.ts +0 -120
- package/dist/src/models/OrderRequestModel.js +0 -88
- package/dist/src/models/OrderSummariesModel.d.ts +0 -51
- package/dist/src/models/OrderSummariesModel.js +0 -56
- package/dist/src/models/OrderSummaryDTO.d.ts +0 -126
- package/dist/src/models/OrderSummaryDTO.js +0 -83
- package/dist/src/models/OrderTotalModel.d.ts +0 -111
- package/dist/src/models/OrderTotalModel.js +0 -100
- package/dist/src/models/OrderedItemEntity.d.ts +0 -110
- package/dist/src/models/OrderedItemEntity.js +0 -75
- package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +0 -32
- package/dist/src/models/PatchSetTcxWizardCnameRequest.js +0 -49
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +0 -32
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +0 -49
- package/dist/src/models/PortalAccountModel.d.ts +0 -171
- package/dist/src/models/PortalAccountModel.js +0 -96
- package/dist/src/models/PortalLoginModel.d.ts +0 -68
- package/dist/src/models/PortalLoginModel.js +0 -61
- package/dist/src/models/PostAddWebhook200Response.d.ts +0 -32
- package/dist/src/models/PostAddWebhook200Response.js +0 -49
- package/dist/src/models/PostGetClientCredentialsRequest.d.ts +0 -32
- package/dist/src/models/PostGetClientCredentialsRequest.js +0 -49
- package/dist/src/models/PostGetProductForCustomerRequest.d.ts +0 -50
- package/dist/src/models/PostGetProductForCustomerRequest.js +0 -55
- package/dist/src/models/PostGetProductRequest.d.ts +0 -44
- package/dist/src/models/PostGetProductRequest.js +0 -53
- package/dist/src/models/PriceListItemModel.d.ts +0 -56
- package/dist/src/models/PriceListItemModel.js +0 -57
- package/dist/src/models/PrizesEntity.d.ts +0 -62
- package/dist/src/models/PrizesEntity.js +0 -59
- package/dist/src/models/ProductPriceListItemModel.d.ts +0 -62
- package/dist/src/models/ProductPriceListItemModel.js +0 -59
- package/dist/src/models/ProductSearchResultsModel.d.ts +0 -33
- package/dist/src/models/ProductSearchResultsModel.js +0 -50
- package/dist/src/models/ProductSerialInfoModel.d.ts +0 -50
- package/dist/src/models/ProductSerialInfoModel.js +0 -55
- package/dist/src/models/ProductSummaryDTO.d.ts +0 -81
- package/dist/src/models/ProductSummaryDTO.js +0 -66
- package/dist/src/models/PromoCodesEntity.d.ts +0 -98
- package/dist/src/models/PromoCodesEntity.js +0 -71
- package/dist/src/models/PromoItemsEntity.d.ts +0 -74
- package/dist/src/models/PromoItemsEntity.js +0 -63
- package/dist/src/models/ProvisioningModel.d.ts +0 -56
- package/dist/src/models/ProvisioningModel.js +0 -57
- package/dist/src/models/ProvisioningRequestEntity.d.ts +0 -44
- package/dist/src/models/ProvisioningRequestEntity.js +0 -53
- package/dist/src/models/RecordingBackupAzureModel.d.ts +0 -50
- package/dist/src/models/RecordingBackupAzureModel.js +0 -55
- package/dist/src/models/RecordingsBackupInfoDTO.d.ts +0 -40
- package/dist/src/models/RecordingsBackupInfoDTO.js +0 -53
- package/dist/src/models/ResourceNotReadyException.d.ts +0 -44
- package/dist/src/models/ResourceNotReadyException.js +0 -53
- package/dist/src/models/RootAccessModel.d.ts +0 -44
- package/dist/src/models/RootAccessModel.js +0 -53
- package/dist/src/models/S3BucketEntity.d.ts +0 -50
- package/dist/src/models/S3BucketEntity.js +0 -55
- package/dist/src/models/ScannedItemModel.d.ts +0 -56
- package/dist/src/models/ScannedItemModel.js +0 -57
- package/dist/src/models/ScopeModel.d.ts +0 -38
- package/dist/src/models/ScopeModel.js +0 -51
- package/dist/src/models/ServiceEnum.d.ts +0 -14
- package/dist/src/models/ServiceEnum.js +0 -19
- package/dist/src/models/ServiceHealthDTO.d.ts +0 -48
- package/dist/src/models/ServiceHealthDTO.js +0 -61
- package/dist/src/models/ServiceHealthEnum.d.ts +0 -19
- package/dist/src/models/ServiceHealthEnum.js +0 -24
- package/dist/src/models/ServiceStatusDTO.d.ts +0 -60
- package/dist/src/models/ServiceStatusDTO.js +0 -65
- package/dist/src/models/ServiceStatusEnum.d.ts +0 -19
- package/dist/src/models/ServiceStatusEnum.js +0 -24
- package/dist/src/models/ShipmentAddressEntity.d.ts +0 -92
- package/dist/src/models/ShipmentAddressEntity.js +0 -69
- package/dist/src/models/ShipmentEntity.d.ts +0 -98
- package/dist/src/models/ShipmentEntity.js +0 -71
- package/dist/src/models/ShipmentItemEntity.d.ts +0 -56
- package/dist/src/models/ShipmentItemEntity.js +0 -57
- package/dist/src/models/ShippingConsignmentModel.d.ts +0 -51
- package/dist/src/models/ShippingConsignmentModel.js +0 -56
- package/dist/src/models/ShippingInformationDTO.d.ts +0 -45
- package/dist/src/models/ShippingInformationDTO.js +0 -54
- package/dist/src/models/ShippingServiceDTO.d.ts +0 -47
- package/dist/src/models/ShippingServiceDTO.js +0 -60
- package/dist/src/models/ShippingServiceModel.d.ts +0 -71
- package/dist/src/models/ShippingServiceModel.js +0 -68
- package/dist/src/models/ShippingServicesModel.d.ts +0 -33
- package/dist/src/models/ShippingServicesModel.js +0 -50
- package/dist/src/models/SipTrunkChangeResponseModel.d.ts +0 -77
- package/dist/src/models/SipTrunkChangeResponseModel.js +0 -78
- package/dist/src/models/SipTrunkCreationRequestModel.d.ts +0 -66
- package/dist/src/models/SipTrunkCreationRequestModel.js +0 -63
- package/dist/src/models/SipTrunkEntity.d.ts +0 -98
- package/dist/src/models/SipTrunkEntity.js +0 -71
- package/dist/src/models/SipTrunksResponseModel.d.ts +0 -51
- package/dist/src/models/SipTrunksResponseModel.js +0 -56
- package/dist/src/models/SmsAccountEntity.d.ts +0 -68
- package/dist/src/models/SmsAccountEntity.js +0 -61
- package/dist/src/models/SmsDataModel.d.ts +0 -33
- package/dist/src/models/SmsDataModel.js +0 -50
- package/dist/src/models/SmsMessageModel.d.ts +0 -44
- package/dist/src/models/SmsMessageModel.js +0 -53
- package/dist/src/models/SmsNumbersEntity.d.ts +0 -38
- package/dist/src/models/SmsNumbersEntity.js +0 -51
- package/dist/src/models/SmsPayloadModel.d.ts +0 -45
- package/dist/src/models/SmsPayloadModel.js +0 -54
- package/dist/src/models/SmsPhoneNumberModel.d.ts +0 -53
- package/dist/src/models/SmsPhoneNumberModel.js +0 -66
- package/dist/src/models/SmsResponseModel.d.ts +0 -67
- package/dist/src/models/SmsResponseModel.js +0 -68
- package/dist/src/models/SmsWhitelistEntity.d.ts +0 -38
- package/dist/src/models/SmsWhitelistEntity.js +0 -51
- package/dist/src/models/StockOrderCourierEntity.d.ts +0 -50
- package/dist/src/models/StockOrderCourierEntity.js +0 -55
- package/dist/src/models/StockOrderDeductionModel.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionModel.js +0 -55
- package/dist/src/models/StockOrderDeductionRequestModel.d.ts +0 -38
- package/dist/src/models/StockOrderDeductionRequestModel.js +0 -51
- package/dist/src/models/StockOrderDeductionsEntity.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionsEntity.js +0 -55
- package/dist/src/models/StockOrderEntity.d.ts +0 -158
- package/dist/src/models/StockOrderEntity.js +0 -91
- package/dist/src/models/StockOrderItemEntity.d.ts +0 -68
- package/dist/src/models/StockOrderItemEntity.js +0 -61
- package/dist/src/models/StockOrderItemModel.d.ts +0 -80
- package/dist/src/models/StockOrderItemModel.js +0 -65
- package/dist/src/models/StockOrderItemRequestModel.d.ts +0 -50
- package/dist/src/models/StockOrderItemRequestModel.js +0 -55
- package/dist/src/models/StockOrderModel.d.ts +0 -137
- package/dist/src/models/StockOrderModel.js +0 -97
- package/dist/src/models/StockOrderProductEntity.d.ts +0 -62
- package/dist/src/models/StockOrderProductEntity.js +0 -59
- package/dist/src/models/StockOrderRequestModel.d.ts +0 -46
- package/dist/src/models/StockOrderRequestModel.js +0 -55
- package/dist/src/models/StockOrderSupplierEntity.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierEntity.js +0 -65
- package/dist/src/models/StockOrderSupplierModel.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierModel.js +0 -65
- package/dist/src/models/StockOrdersModel.d.ts +0 -51
- package/dist/src/models/StockOrdersModel.js +0 -56
- package/dist/src/models/StockProductModel.d.ts +0 -120
- package/dist/src/models/StockProductModel.js +0 -81
- package/dist/src/models/StockProductPriceModel.d.ts +0 -39
- package/dist/src/models/StockProductPriceModel.js +0 -52
- package/dist/src/models/StockProductSummariesModel.d.ts +0 -51
- package/dist/src/models/StockProductSummariesModel.js +0 -56
- package/dist/src/models/StockProductSummaryModel.d.ts +0 -69
- package/dist/src/models/StockProductSummaryModel.js +0 -62
- package/dist/src/models/StockTransactionsEntity.d.ts +0 -74
- package/dist/src/models/StockTransactionsEntity.js +0 -63
- package/dist/src/models/SupplierEntity.d.ts +0 -80
- package/dist/src/models/SupplierEntity.js +0 -65
- package/dist/src/models/SupplierItemEntity.d.ts +0 -74
- package/dist/src/models/SupplierItemEntity.js +0 -63
- package/dist/src/models/TcxBackupEntity.d.ts +0 -80
- package/dist/src/models/TcxBackupEntity.js +0 -65
- package/dist/src/models/TcxBackupModel.d.ts +0 -140
- package/dist/src/models/TcxBackupModel.js +0 -85
- package/dist/src/models/TcxBillingEntity.d.ts +0 -86
- package/dist/src/models/TcxBillingEntity.js +0 -67
- package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +0 -40
- package/dist/src/models/TcxBulkLicenceDetailsModel.js +0 -53
- package/dist/src/models/TcxDeadLicenceEntity.d.ts +0 -44
- package/dist/src/models/TcxDeadLicenceEntity.js +0 -53
- package/dist/src/models/TcxExtsEntity.d.ts +0 -74
- package/dist/src/models/TcxExtsEntity.js +0 -63
- package/dist/src/models/TcxHostingPricingEntity.d.ts +0 -74
- package/dist/src/models/TcxHostingPricingEntity.js +0 -63
- package/dist/src/models/TcxInstallationDetailsModel.d.ts +0 -106
- package/dist/src/models/TcxInstallationDetailsModel.js +0 -75
- package/dist/src/models/TcxInstallationModel.d.ts +0 -200
- package/dist/src/models/TcxInstallationModel.js +0 -105
- package/dist/src/models/TcxInstallationsModel.d.ts +0 -51
- package/dist/src/models/TcxInstallationsModel.js +0 -56
- package/dist/src/models/TcxKeySummaryDTO.d.ts +0 -56
- package/dist/src/models/TcxKeySummaryDTO.js +0 -57
- package/dist/src/models/TcxKeysEntity.d.ts +0 -62
- package/dist/src/models/TcxKeysEntity.js +0 -59
- package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +0 -50
- package/dist/src/models/TcxLicenceDetailsErrorModel.js +0 -55
- package/dist/src/models/TcxLicenceDetailsModel.d.ts +0 -92
- package/dist/src/models/TcxLicenceDetailsModel.js +0 -69
- package/dist/src/models/TcxMacsEntity.d.ts +0 -44
- package/dist/src/models/TcxMacsEntity.js +0 -53
- package/dist/src/models/TcxMultiTenantModel.d.ts +0 -118
- package/dist/src/models/TcxMultiTenantModel.js +0 -83
- package/dist/src/models/TcxMultiTenantUserModel.d.ts +0 -44
- package/dist/src/models/TcxMultiTenantUserModel.js +0 -53
- package/dist/src/models/TcxMultiTenantsModel.d.ts +0 -51
- package/dist/src/models/TcxMultiTenantsModel.js +0 -56
- package/dist/src/models/TcxNumbersEntity.d.ts +0 -44
- package/dist/src/models/TcxNumbersEntity.js +0 -53
- package/dist/src/models/TcxOfficeHoursEntity.d.ts +0 -116
- package/dist/src/models/TcxOfficeHoursEntity.js +0 -77
- package/dist/src/models/TcxPhoneModel.d.ts +0 -68
- package/dist/src/models/TcxPhoneModel.js +0 -61
- package/dist/src/models/TcxPhonesEntity.d.ts +0 -62
- package/dist/src/models/TcxPhonesEntity.js +0 -59
- package/dist/src/models/TcxRemoteStorageModel.d.ts +0 -50
- package/dist/src/models/TcxRemoteStorageModel.js +0 -55
- package/dist/src/models/TcxSbcDTO.d.ts +0 -62
- package/dist/src/models/TcxSbcDTO.js +0 -59
- package/dist/src/models/TcxSbcEntity.d.ts +0 -122
- package/dist/src/models/TcxSbcEntity.js +0 -79
- package/dist/src/models/TcxSbcModel.d.ts +0 -122
- package/dist/src/models/TcxSbcModel.js +0 -79
- package/dist/src/models/TcxSetupEntity.d.ts +0 -207
- package/dist/src/models/TcxSetupEntity.js +0 -123
- package/dist/src/models/TcxSetupsModel.d.ts +0 -51
- package/dist/src/models/TcxSetupsModel.js +0 -56
- package/dist/src/models/TcxSipTrunksEntity.d.ts +0 -104
- package/dist/src/models/TcxSipTrunksEntity.js +0 -73
- package/dist/src/models/TcxTemplateXmlEnum.d.ts +0 -38
- package/dist/src/models/TcxTemplateXmlEnum.js +0 -51
- package/dist/src/models/TcxUsersEntity.d.ts +0 -62
- package/dist/src/models/TcxUsersEntity.js +0 -59
- package/dist/src/models/TcxWizardConfigModel.d.ts +0 -39
- package/dist/src/models/TcxWizardConfigModel.js +0 -52
- package/dist/src/models/TcxWizardModel.d.ts +0 -150
- package/dist/src/models/TcxWizardModel.js +0 -114
- package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +0 -57
- package/dist/src/models/TechSupportCompanySummaryDTO.js +0 -58
- package/dist/src/models/TelephonySupportTicketModel.d.ts +0 -94
- package/dist/src/models/TelephonySupportTicketModel.js +0 -71
- package/dist/src/models/TicketSummaryModel.d.ts +0 -74
- package/dist/src/models/TicketSummaryModel.js +0 -63
- package/dist/src/models/TicketTimeDTO.d.ts +0 -80
- package/dist/src/models/TicketTimeDTO.js +0 -65
- package/dist/src/models/TokenResponseModel.d.ts +0 -44
- package/dist/src/models/TokenResponseModel.js +0 -53
- package/dist/src/models/UpdateTypeEnum.d.ts +0 -19
- package/dist/src/models/UpdateTypeEnum.js +0 -24
- package/dist/src/models/UpgradeOrderResponseModel.d.ts +0 -38
- package/dist/src/models/UpgradeOrderResponseModel.js +0 -51
- package/dist/src/models/UpgradeRequestModel.d.ts +0 -66
- package/dist/src/models/UpgradeRequestModel.js +0 -70
- package/dist/src/models/UserEntity.d.ts +0 -98
- package/dist/src/models/UserEntity.js +0 -71
- package/dist/src/models/XeroLogEntity.d.ts +0 -86
- package/dist/src/models/XeroLogEntity.js +0 -67
- package/dist/src/models/index.d.ts +0 -196
- package/dist/src/models/index.js +0 -214
- package/dist/src/runtime.d.ts +0 -184
- package/dist/src/runtime.js +0 -564
- package/docs/AccountAddressesDTO.md +0 -25
- package/docs/AccountFinanceDTO.md +0 -37
- package/docs/AddressDTO.md +0 -31
- package/docs/CrmActivitiesResponseDTO.md +0 -23
- package/docs/CrmActivityDTO.md +0 -33
- package/docs/CrmDateActivitiesDTO.md +0 -23
- package/docs/CrmNoteEntity.md +0 -39
- package/docs/CrmNoteModel.md +0 -39
- package/docs/CustomerListAccountDTO.md +0 -45
- package/docs/NumberPortAdminNoteBody.md +0 -20
- package/docs/PartnerDTO.md +0 -39
- package/docs/PatchUpdateAccountCompanyNumberRequest.md +0 -20
- package/docs/PatchUpdateAccountPhoneRequest.md +0 -20
- package/docs/PatchUpdateAccountVatNumberRequest.md +0 -20
- package/docs/PatchUpdateCreditLimitRequest.md +0 -20
- package/docs/PatchUpdatePriceListRequest.md +0 -20
- package/docs/PatchUpdateSipChannelCostRequest.md +0 -20
- package/docs/PatchUpdateTcxHostingPriceListRequest.md +0 -20
- package/docs/PatchUpdateTcxPartnerIdRequest.md +0 -20
- package/docs/PostSendWelcomeEmailRequest.md +0 -20
- package/docs/TableHistoryEntity.md +0 -35
package/docs/AccountsApi.md
CHANGED
|
@@ -1,163 +1,28 @@
|
|
|
1
1
|
# AccountsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
|
|
8
|
-
|[**deleteArchiveAccount**](#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | |
|
|
9
7
|
|[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
|
|
10
8
|
|[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
|
|
11
|
-
|[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
|
|
12
9
|
|[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
|
|
13
|
-
|[**getGetAccountAddresses**](#getgetaccountaddresses) | **GET** /admin/accounts/{id}/addresses | |
|
|
14
10
|
|[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
|
|
15
11
|
|[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
|
|
16
12
|
|[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
|
|
17
13
|
|[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
|
|
18
|
-
|[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
|
|
19
14
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
20
|
-
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
21
|
-
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
22
|
-
|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
|
|
23
15
|
|[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
|
|
24
|
-
|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
|
|
25
|
-
|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
|
|
26
16
|
|[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
|
|
27
|
-
|[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
|
|
28
|
-
|[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
|
|
29
17
|
|[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
|
|
30
|
-
|[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
|
|
31
|
-
|[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
|
|
32
|
-
|[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
|
|
33
|
-
|[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
|
|
34
|
-
|[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
|
|
35
|
-
|[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
|
|
36
|
-
|[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
|
|
37
|
-
|[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
|
|
38
18
|
|[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
|
|
39
19
|
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
|
|
40
20
|
|[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
|
|
41
21
|
|[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
|
|
42
22
|
|[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
|
|
43
23
|
|[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
|
|
44
|
-
|[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
|
|
45
24
|
|[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
|
|
46
|
-
|[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
|
|
47
25
|
|[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
|
|
48
|
-
|[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
|
|
49
|
-
|[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
|
|
50
|
-
|
|
51
|
-
# **deleteAdminUpdateAccountContact**
|
|
52
|
-
> deleteAdminUpdateAccountContact()
|
|
53
|
-
|
|
54
|
-
Delete Account Contact
|
|
55
|
-
|
|
56
|
-
### Example
|
|
57
|
-
|
|
58
|
-
```typescript
|
|
59
|
-
import {
|
|
60
|
-
AccountsApi,
|
|
61
|
-
Configuration
|
|
62
|
-
} from 'yellowgrid-api-ts';
|
|
63
|
-
|
|
64
|
-
const configuration = new Configuration();
|
|
65
|
-
const apiInstance = new AccountsApi(configuration);
|
|
66
|
-
|
|
67
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
68
|
-
let contactId: number; //Contact ID (default to undefined)
|
|
69
|
-
|
|
70
|
-
const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
|
|
71
|
-
id,
|
|
72
|
-
contactId
|
|
73
|
-
);
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### Parameters
|
|
77
|
-
|
|
78
|
-
|Name | Type | Description | Notes|
|
|
79
|
-
|------------- | ------------- | ------------- | -------------|
|
|
80
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
81
|
-
| **contactId** | [**number**] | Contact ID | defaults to undefined|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
### Return type
|
|
85
|
-
|
|
86
|
-
void (empty response body)
|
|
87
|
-
|
|
88
|
-
### Authorization
|
|
89
|
-
|
|
90
|
-
No authorization required
|
|
91
|
-
|
|
92
|
-
### HTTP request headers
|
|
93
|
-
|
|
94
|
-
- **Content-Type**: Not defined
|
|
95
|
-
- **Accept**: Not defined
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
### HTTP response details
|
|
99
|
-
| Status code | Description | Response headers |
|
|
100
|
-
|-------------|-------------|------------------|
|
|
101
|
-
|**204** | No Response | - |
|
|
102
|
-
|**400** | Bad Request | - |
|
|
103
|
-
|**401** | Unauthorised | - |
|
|
104
|
-
|**403** | Access Denied | - |
|
|
105
|
-
|
|
106
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
107
|
-
|
|
108
|
-
# **deleteArchiveAccount**
|
|
109
|
-
> deleteArchiveAccount()
|
|
110
|
-
|
|
111
|
-
Delete Account
|
|
112
|
-
|
|
113
|
-
### Example
|
|
114
|
-
|
|
115
|
-
```typescript
|
|
116
|
-
import {
|
|
117
|
-
AccountsApi,
|
|
118
|
-
Configuration
|
|
119
|
-
} from 'yellowgrid-api-ts';
|
|
120
|
-
|
|
121
|
-
const configuration = new Configuration();
|
|
122
|
-
const apiInstance = new AccountsApi(configuration);
|
|
123
|
-
|
|
124
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
125
|
-
|
|
126
|
-
const { status, data } = await apiInstance.deleteArchiveAccount(
|
|
127
|
-
id
|
|
128
|
-
);
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
### Parameters
|
|
132
|
-
|
|
133
|
-
|Name | Type | Description | Notes|
|
|
134
|
-
|------------- | ------------- | ------------- | -------------|
|
|
135
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
### Return type
|
|
139
|
-
|
|
140
|
-
void (empty response body)
|
|
141
|
-
|
|
142
|
-
### Authorization
|
|
143
|
-
|
|
144
|
-
No authorization required
|
|
145
|
-
|
|
146
|
-
### HTTP request headers
|
|
147
|
-
|
|
148
|
-
- **Content-Type**: Not defined
|
|
149
|
-
- **Accept**: Not defined
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
### HTTP response details
|
|
153
|
-
| Status code | Description | Response headers |
|
|
154
|
-
|-------------|-------------|------------------|
|
|
155
|
-
|**204** | No Response | - |
|
|
156
|
-
|**400** | Bad Request | - |
|
|
157
|
-
|**401** | Unauthorised | - |
|
|
158
|
-
|**403** | Access Denied | - |
|
|
159
|
-
|
|
160
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
161
26
|
|
|
162
27
|
# **deleteDeleteClientCredentials**
|
|
163
28
|
> deleteDeleteClientCredentials()
|
|
@@ -267,60 +132,6 @@ No authorization required
|
|
|
267
132
|
|
|
268
133
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
269
134
|
|
|
270
|
-
# **getAdminCreateAccountContact**
|
|
271
|
-
> Array<AccountContactModel> getAdminCreateAccountContact()
|
|
272
|
-
|
|
273
|
-
Get Account Contacts
|
|
274
|
-
|
|
275
|
-
### Example
|
|
276
|
-
|
|
277
|
-
```typescript
|
|
278
|
-
import {
|
|
279
|
-
AccountsApi,
|
|
280
|
-
Configuration
|
|
281
|
-
} from 'yellowgrid-api-ts';
|
|
282
|
-
|
|
283
|
-
const configuration = new Configuration();
|
|
284
|
-
const apiInstance = new AccountsApi(configuration);
|
|
285
|
-
|
|
286
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
287
|
-
|
|
288
|
-
const { status, data } = await apiInstance.getAdminCreateAccountContact(
|
|
289
|
-
id
|
|
290
|
-
);
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Parameters
|
|
294
|
-
|
|
295
|
-
|Name | Type | Description | Notes|
|
|
296
|
-
|------------- | ------------- | ------------- | -------------|
|
|
297
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
### Return type
|
|
301
|
-
|
|
302
|
-
**Array<AccountContactModel>**
|
|
303
|
-
|
|
304
|
-
### Authorization
|
|
305
|
-
|
|
306
|
-
No authorization required
|
|
307
|
-
|
|
308
|
-
### HTTP request headers
|
|
309
|
-
|
|
310
|
-
- **Content-Type**: Not defined
|
|
311
|
-
- **Accept**: application/json
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
### HTTP response details
|
|
315
|
-
| Status code | Description | Response headers |
|
|
316
|
-
|-------------|-------------|------------------|
|
|
317
|
-
|**200** | Account | - |
|
|
318
|
-
|**400** | Bad Request | - |
|
|
319
|
-
|**401** | Unauthorised | - |
|
|
320
|
-
|**403** | Access Denied | - |
|
|
321
|
-
|
|
322
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
323
|
-
|
|
324
135
|
# **getGetAccount**
|
|
325
136
|
> PortalAccountModel getGetAccount()
|
|
326
137
|
|
|
@@ -368,60 +179,6 @@ No authorization required
|
|
|
368
179
|
|
|
369
180
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
370
181
|
|
|
371
|
-
# **getGetAccountAddresses**
|
|
372
|
-
> AccountAddressesDTO getGetAccountAddresses()
|
|
373
|
-
|
|
374
|
-
Get Account Addresses
|
|
375
|
-
|
|
376
|
-
### Example
|
|
377
|
-
|
|
378
|
-
```typescript
|
|
379
|
-
import {
|
|
380
|
-
AccountsApi,
|
|
381
|
-
Configuration
|
|
382
|
-
} from 'yellowgrid-api-ts';
|
|
383
|
-
|
|
384
|
-
const configuration = new Configuration();
|
|
385
|
-
const apiInstance = new AccountsApi(configuration);
|
|
386
|
-
|
|
387
|
-
let id: string; //Xero ID (default to undefined)
|
|
388
|
-
|
|
389
|
-
const { status, data } = await apiInstance.getGetAccountAddresses(
|
|
390
|
-
id
|
|
391
|
-
);
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
### Parameters
|
|
395
|
-
|
|
396
|
-
|Name | Type | Description | Notes|
|
|
397
|
-
|------------- | ------------- | ------------- | -------------|
|
|
398
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
### Return type
|
|
402
|
-
|
|
403
|
-
**AccountAddressesDTO**
|
|
404
|
-
|
|
405
|
-
### Authorization
|
|
406
|
-
|
|
407
|
-
No authorization required
|
|
408
|
-
|
|
409
|
-
### HTTP request headers
|
|
410
|
-
|
|
411
|
-
- **Content-Type**: Not defined
|
|
412
|
-
- **Accept**: application/json
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
### HTTP response details
|
|
416
|
-
| Status code | Description | Response headers |
|
|
417
|
-
|-------------|-------------|------------------|
|
|
418
|
-
|**200** | Account Addresses | - |
|
|
419
|
-
|**400** | Bad Request | - |
|
|
420
|
-
|**401** | Unauthorised | - |
|
|
421
|
-
|**403** | Access Denied | - |
|
|
422
|
-
|
|
423
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
424
|
-
|
|
425
182
|
# **getGetAccountContacts**
|
|
426
183
|
> Array<AccountContactModel> getGetAccountContacts()
|
|
427
184
|
|
|
@@ -593,910 +350,32 @@ No authorization required
|
|
|
593
350
|
|
|
594
351
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
595
352
|
|
|
596
|
-
# **getGetClientCredentials**
|
|
597
|
-
> Array<ClientModel> getGetClientCredentials()
|
|
598
|
-
|
|
599
|
-
Get user\'s client credentials
|
|
600
|
-
|
|
601
|
-
### Example
|
|
602
|
-
|
|
603
|
-
```typescript
|
|
604
|
-
import {
|
|
605
|
-
AccountsApi,
|
|
606
|
-
Configuration
|
|
607
|
-
} from 'yellowgrid-api-ts';
|
|
608
|
-
|
|
609
|
-
const configuration = new Configuration();
|
|
610
|
-
const apiInstance = new AccountsApi(configuration);
|
|
611
|
-
|
|
612
|
-
const { status, data } = await apiInstance.getGetClientCredentials();
|
|
613
|
-
```
|
|
614
|
-
|
|
615
|
-
### Parameters
|
|
616
|
-
This endpoint does not have any parameters.
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
### Return type
|
|
620
|
-
|
|
621
|
-
**Array<ClientModel>**
|
|
622
|
-
|
|
623
|
-
### Authorization
|
|
624
|
-
|
|
625
|
-
No authorization required
|
|
626
|
-
|
|
627
|
-
### HTTP request headers
|
|
628
|
-
|
|
629
|
-
- **Content-Type**: Not defined
|
|
630
|
-
- **Accept**: application/json
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
### HTTP response details
|
|
634
|
-
| Status code | Description | Response headers |
|
|
635
|
-
|-------------|-------------|------------------|
|
|
636
|
-
|**200** | List of client credentials | - |
|
|
637
|
-
|**400** | Bad Request | - |
|
|
638
|
-
|**401** | Unauthorised | - |
|
|
639
|
-
|**403** | Access Denied | - |
|
|
640
|
-
|
|
641
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
642
|
-
|
|
643
|
-
# **getGetCustomerAccountsList**
|
|
644
|
-
> Array<CustomerListAccountDTO> getGetCustomerAccountsList()
|
|
645
|
-
|
|
646
|
-
Get Customer Accounts List
|
|
647
|
-
|
|
648
|
-
### Example
|
|
649
|
-
|
|
650
|
-
```typescript
|
|
651
|
-
import {
|
|
652
|
-
AccountsApi,
|
|
653
|
-
Configuration
|
|
654
|
-
} from 'yellowgrid-api-ts';
|
|
655
|
-
|
|
656
|
-
const configuration = new Configuration();
|
|
657
|
-
const apiInstance = new AccountsApi(configuration);
|
|
658
|
-
|
|
659
|
-
const { status, data } = await apiInstance.getGetCustomerAccountsList();
|
|
660
|
-
```
|
|
661
|
-
|
|
662
|
-
### Parameters
|
|
663
|
-
This endpoint does not have any parameters.
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
### Return type
|
|
667
|
-
|
|
668
|
-
**Array<CustomerListAccountDTO>**
|
|
669
|
-
|
|
670
|
-
### Authorization
|
|
671
|
-
|
|
672
|
-
No authorization required
|
|
673
|
-
|
|
674
|
-
### HTTP request headers
|
|
675
|
-
|
|
676
|
-
- **Content-Type**: Not defined
|
|
677
|
-
- **Accept**: application/json
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
### HTTP response details
|
|
681
|
-
| Status code | Description | Response headers |
|
|
682
|
-
|-------------|-------------|------------------|
|
|
683
|
-
|**200** | Account Addresses | - |
|
|
684
|
-
|**400** | Bad Request | - |
|
|
685
|
-
|**401** | Unauthorised | - |
|
|
686
|
-
|**403** | Access Denied | - |
|
|
687
|
-
|
|
688
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
689
|
-
|
|
690
|
-
# **getGetCustomerKeys**
|
|
691
|
-
> Array<TcxKeySummaryDTO> getGetCustomerKeys()
|
|
692
|
-
|
|
693
|
-
Get 3CX Keys
|
|
694
|
-
|
|
695
|
-
### Example
|
|
696
|
-
|
|
697
|
-
```typescript
|
|
698
|
-
import {
|
|
699
|
-
AccountsApi,
|
|
700
|
-
Configuration
|
|
701
|
-
} from 'yellowgrid-api-ts';
|
|
702
|
-
|
|
703
|
-
const configuration = new Configuration();
|
|
704
|
-
const apiInstance = new AccountsApi(configuration);
|
|
705
|
-
|
|
706
|
-
const { status, data } = await apiInstance.getGetCustomerKeys();
|
|
707
|
-
```
|
|
708
|
-
|
|
709
|
-
### Parameters
|
|
710
|
-
This endpoint does not have any parameters.
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
### Return type
|
|
714
|
-
|
|
715
|
-
**Array<TcxKeySummaryDTO>**
|
|
716
|
-
|
|
717
|
-
### Authorization
|
|
718
|
-
|
|
719
|
-
No authorization required
|
|
720
|
-
|
|
721
|
-
### HTTP request headers
|
|
722
|
-
|
|
723
|
-
- **Content-Type**: Not defined
|
|
724
|
-
- **Accept**: application/json
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
### HTTP response details
|
|
728
|
-
| Status code | Description | Response headers |
|
|
729
|
-
|-------------|-------------|------------------|
|
|
730
|
-
|**200** | 3CX Key Summaries | - |
|
|
731
|
-
|**400** | Bad Request | - |
|
|
732
|
-
|**401** | Unauthorised | - |
|
|
733
|
-
|**403** | Access Denied | - |
|
|
734
|
-
|
|
735
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
736
|
-
|
|
737
|
-
# **getGetFinanceSettings**
|
|
738
|
-
> AccountFinanceDTO getGetFinanceSettings()
|
|
739
|
-
|
|
740
|
-
Get Account Finance
|
|
741
|
-
|
|
742
|
-
### Example
|
|
743
|
-
|
|
744
|
-
```typescript
|
|
745
|
-
import {
|
|
746
|
-
AccountsApi,
|
|
747
|
-
Configuration
|
|
748
|
-
} from 'yellowgrid-api-ts';
|
|
749
|
-
|
|
750
|
-
const configuration = new Configuration();
|
|
751
|
-
const apiInstance = new AccountsApi(configuration);
|
|
752
|
-
|
|
753
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
754
|
-
|
|
755
|
-
const { status, data } = await apiInstance.getGetFinanceSettings(
|
|
756
|
-
id
|
|
757
|
-
);
|
|
758
|
-
```
|
|
759
|
-
|
|
760
|
-
### Parameters
|
|
761
|
-
|
|
762
|
-
|Name | Type | Description | Notes|
|
|
763
|
-
|------------- | ------------- | ------------- | -------------|
|
|
764
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
### Return type
|
|
768
|
-
|
|
769
|
-
**AccountFinanceDTO**
|
|
770
|
-
|
|
771
|
-
### Authorization
|
|
772
|
-
|
|
773
|
-
No authorization required
|
|
774
|
-
|
|
775
|
-
### HTTP request headers
|
|
776
|
-
|
|
777
|
-
- **Content-Type**: Not defined
|
|
778
|
-
- **Accept**: application/json
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
### HTTP response details
|
|
782
|
-
| Status code | Description | Response headers |
|
|
783
|
-
|-------------|-------------|------------------|
|
|
784
|
-
|**200** | Accounts Finance Details | - |
|
|
785
|
-
|**400** | Bad Request | - |
|
|
786
|
-
|**401** | Unauthorised | - |
|
|
787
|
-
|**403** | Access Denied | - |
|
|
788
|
-
|
|
789
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
790
|
-
|
|
791
|
-
# **getGetLastAccount**
|
|
792
|
-
> AccountSummaryDTO getGetLastAccount()
|
|
793
|
-
|
|
794
|
-
Get Last Account
|
|
795
|
-
|
|
796
|
-
### Example
|
|
797
|
-
|
|
798
|
-
```typescript
|
|
799
|
-
import {
|
|
800
|
-
AccountsApi,
|
|
801
|
-
Configuration
|
|
802
|
-
} from 'yellowgrid-api-ts';
|
|
803
|
-
|
|
804
|
-
const configuration = new Configuration();
|
|
805
|
-
const apiInstance = new AccountsApi(configuration);
|
|
806
|
-
|
|
807
|
-
const { status, data } = await apiInstance.getGetLastAccount();
|
|
808
|
-
```
|
|
809
|
-
|
|
810
|
-
### Parameters
|
|
811
|
-
This endpoint does not have any parameters.
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
### Return type
|
|
815
|
-
|
|
816
|
-
**AccountSummaryDTO**
|
|
817
|
-
|
|
818
|
-
### Authorization
|
|
819
|
-
|
|
820
|
-
No authorization required
|
|
821
|
-
|
|
822
|
-
### HTTP request headers
|
|
823
|
-
|
|
824
|
-
- **Content-Type**: Not defined
|
|
825
|
-
- **Accept**: application/json
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
### HTTP response details
|
|
829
|
-
| Status code | Description | Response headers |
|
|
830
|
-
|-------------|-------------|------------------|
|
|
831
|
-
|**200** | Account Summary | - |
|
|
832
|
-
|**400** | Bad Request | - |
|
|
833
|
-
|**401** | Unauthorised | - |
|
|
834
|
-
|**403** | Access Denied | - |
|
|
835
|
-
|
|
836
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
837
|
-
|
|
838
|
-
# **getGetTcxPartnerDetails**
|
|
839
|
-
> PartnerDTO getGetTcxPartnerDetails()
|
|
840
|
-
|
|
841
|
-
Get Account 3CX Details
|
|
842
|
-
|
|
843
|
-
### Example
|
|
844
|
-
|
|
845
|
-
```typescript
|
|
846
|
-
import {
|
|
847
|
-
AccountsApi,
|
|
848
|
-
Configuration
|
|
849
|
-
} from 'yellowgrid-api-ts';
|
|
850
|
-
|
|
851
|
-
const configuration = new Configuration();
|
|
852
|
-
const apiInstance = new AccountsApi(configuration);
|
|
853
|
-
|
|
854
|
-
let id: string; //Xero ID (default to undefined)
|
|
855
|
-
|
|
856
|
-
const { status, data } = await apiInstance.getGetTcxPartnerDetails(
|
|
857
|
-
id
|
|
858
|
-
);
|
|
859
|
-
```
|
|
860
|
-
|
|
861
|
-
### Parameters
|
|
862
|
-
|
|
863
|
-
|Name | Type | Description | Notes|
|
|
864
|
-
|------------- | ------------- | ------------- | -------------|
|
|
865
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
### Return type
|
|
869
|
-
|
|
870
|
-
**PartnerDTO**
|
|
871
|
-
|
|
872
|
-
### Authorization
|
|
873
|
-
|
|
874
|
-
No authorization required
|
|
875
|
-
|
|
876
|
-
### HTTP request headers
|
|
877
|
-
|
|
878
|
-
- **Content-Type**: Not defined
|
|
879
|
-
- **Accept**: application/json
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
### HTTP response details
|
|
883
|
-
| Status code | Description | Response headers |
|
|
884
|
-
|-------------|-------------|------------------|
|
|
885
|
-
|**200** | Account 3CX Partner Details | - |
|
|
886
|
-
|**400** | Bad Request | - |
|
|
887
|
-
|**401** | Unauthorised | - |
|
|
888
|
-
|**403** | Access Denied | - |
|
|
889
|
-
|
|
890
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
891
|
-
|
|
892
|
-
# **getVerifyEmailAddress**
|
|
893
|
-
> getVerifyEmailAddress()
|
|
894
|
-
|
|
895
|
-
Verify account email address
|
|
896
|
-
|
|
897
|
-
### Example
|
|
898
|
-
|
|
899
|
-
```typescript
|
|
900
|
-
import {
|
|
901
|
-
AccountsApi,
|
|
902
|
-
Configuration
|
|
903
|
-
} from 'yellowgrid-api-ts';
|
|
904
|
-
|
|
905
|
-
const configuration = new Configuration();
|
|
906
|
-
const apiInstance = new AccountsApi(configuration);
|
|
907
|
-
|
|
908
|
-
let token: string; //Verification Token (default to undefined)
|
|
909
|
-
|
|
910
|
-
const { status, data } = await apiInstance.getVerifyEmailAddress(
|
|
911
|
-
token
|
|
912
|
-
);
|
|
913
|
-
```
|
|
914
|
-
|
|
915
|
-
### Parameters
|
|
916
|
-
|
|
917
|
-
|Name | Type | Description | Notes|
|
|
918
|
-
|------------- | ------------- | ------------- | -------------|
|
|
919
|
-
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
### Return type
|
|
923
|
-
|
|
924
|
-
void (empty response body)
|
|
925
|
-
|
|
926
|
-
### Authorization
|
|
927
|
-
|
|
928
|
-
No authorization required
|
|
929
|
-
|
|
930
|
-
### HTTP request headers
|
|
931
|
-
|
|
932
|
-
- **Content-Type**: Not defined
|
|
933
|
-
- **Accept**: Not defined
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
### HTTP response details
|
|
937
|
-
| Status code | Description | Response headers |
|
|
938
|
-
|-------------|-------------|------------------|
|
|
939
|
-
|**200** | No Response | - |
|
|
940
|
-
|**400** | Bad Request | - |
|
|
941
|
-
|**401** | Unauthorised | - |
|
|
942
|
-
|**403** | Access Denied | - |
|
|
943
|
-
|
|
944
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
945
|
-
|
|
946
|
-
# **patchSetPortalAccess**
|
|
947
|
-
> patchSetPortalAccess()
|
|
948
|
-
|
|
949
|
-
Set Account Portal Access
|
|
950
|
-
|
|
951
|
-
### Example
|
|
952
|
-
|
|
953
|
-
```typescript
|
|
954
|
-
import {
|
|
955
|
-
AccountsApi,
|
|
956
|
-
Configuration
|
|
957
|
-
} from 'yellowgrid-api-ts';
|
|
958
|
-
|
|
959
|
-
const configuration = new Configuration();
|
|
960
|
-
const apiInstance = new AccountsApi(configuration);
|
|
961
|
-
|
|
962
|
-
let id: string; //Xero ID (default to undefined)
|
|
963
|
-
let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
|
|
964
|
-
|
|
965
|
-
const { status, data } = await apiInstance.patchSetPortalAccess(
|
|
966
|
-
id,
|
|
967
|
-
state
|
|
968
|
-
);
|
|
969
|
-
```
|
|
970
|
-
|
|
971
|
-
### Parameters
|
|
972
|
-
|
|
973
|
-
|Name | Type | Description | Notes|
|
|
974
|
-
|------------- | ------------- | ------------- | -------------|
|
|
975
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
976
|
-
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | Portal Access State | defaults to undefined|
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
### Return type
|
|
980
|
-
|
|
981
|
-
void (empty response body)
|
|
982
|
-
|
|
983
|
-
### Authorization
|
|
984
|
-
|
|
985
|
-
No authorization required
|
|
986
|
-
|
|
987
|
-
### HTTP request headers
|
|
988
|
-
|
|
989
|
-
- **Content-Type**: Not defined
|
|
990
|
-
- **Accept**: Not defined
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
### HTTP response details
|
|
994
|
-
| Status code | Description | Response headers |
|
|
995
|
-
|-------------|-------------|------------------|
|
|
996
|
-
|**204** | No Response | - |
|
|
997
|
-
|**400** | Bad Request | - |
|
|
998
|
-
|**401** | Unauthorised | - |
|
|
999
|
-
|**403** | Access Denied | - |
|
|
1000
|
-
|
|
1001
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1002
|
-
|
|
1003
|
-
# **patchSetPrizePromo**
|
|
1004
|
-
> patchSetPrizePromo()
|
|
1005
|
-
|
|
1006
|
-
Set Account Prize Promo
|
|
1007
|
-
|
|
1008
|
-
### Example
|
|
1009
|
-
|
|
1010
|
-
```typescript
|
|
1011
|
-
import {
|
|
1012
|
-
AccountsApi,
|
|
1013
|
-
Configuration
|
|
1014
|
-
} from 'yellowgrid-api-ts';
|
|
1015
|
-
|
|
1016
|
-
const configuration = new Configuration();
|
|
1017
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1018
|
-
|
|
1019
|
-
let id: string; //Xero ID (default to undefined)
|
|
1020
|
-
let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
|
|
1021
|
-
|
|
1022
|
-
const { status, data } = await apiInstance.patchSetPrizePromo(
|
|
1023
|
-
id,
|
|
1024
|
-
state
|
|
1025
|
-
);
|
|
1026
|
-
```
|
|
1027
|
-
|
|
1028
|
-
### Parameters
|
|
1029
|
-
|
|
1030
|
-
|Name | Type | Description | Notes|
|
|
1031
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1032
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1033
|
-
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | Prize Promo State | defaults to undefined|
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
### Return type
|
|
1037
|
-
|
|
1038
|
-
void (empty response body)
|
|
1039
|
-
|
|
1040
|
-
### Authorization
|
|
1041
|
-
|
|
1042
|
-
No authorization required
|
|
1043
|
-
|
|
1044
|
-
### HTTP request headers
|
|
1045
|
-
|
|
1046
|
-
- **Content-Type**: Not defined
|
|
1047
|
-
- **Accept**: Not defined
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
### HTTP response details
|
|
1051
|
-
| Status code | Description | Response headers |
|
|
1052
|
-
|-------------|-------------|------------------|
|
|
1053
|
-
|**204** | No Response | - |
|
|
1054
|
-
|**400** | Bad Request | - |
|
|
1055
|
-
|**401** | Unauthorised | - |
|
|
1056
|
-
|**403** | Access Denied | - |
|
|
1057
|
-
|
|
1058
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1059
|
-
|
|
1060
|
-
# **patchSetTcxWizardCname**
|
|
1061
|
-
> patchSetTcxWizardCname()
|
|
1062
|
-
|
|
1063
|
-
Set 3CX Wizard CNAME
|
|
1064
|
-
|
|
1065
|
-
### Example
|
|
1066
|
-
|
|
1067
|
-
```typescript
|
|
1068
|
-
import {
|
|
1069
|
-
AccountsApi,
|
|
1070
|
-
Configuration,
|
|
1071
|
-
PatchUpdateAccountCnameRequest
|
|
1072
|
-
} from 'yellowgrid-api-ts';
|
|
1073
|
-
|
|
1074
|
-
const configuration = new Configuration();
|
|
1075
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1076
|
-
|
|
1077
|
-
let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
|
|
1078
|
-
|
|
1079
|
-
const { status, data } = await apiInstance.patchSetTcxWizardCname(
|
|
1080
|
-
patchUpdateAccountCnameRequest
|
|
1081
|
-
);
|
|
1082
|
-
```
|
|
1083
|
-
|
|
1084
|
-
### Parameters
|
|
1085
|
-
|
|
1086
|
-
|Name | Type | Description | Notes|
|
|
1087
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1088
|
-
| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
### Return type
|
|
1092
|
-
|
|
1093
|
-
void (empty response body)
|
|
1094
|
-
|
|
1095
|
-
### Authorization
|
|
1096
|
-
|
|
1097
|
-
No authorization required
|
|
1098
|
-
|
|
1099
|
-
### HTTP request headers
|
|
1100
|
-
|
|
1101
|
-
- **Content-Type**: application/json
|
|
1102
|
-
- **Accept**: Not defined
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
### HTTP response details
|
|
1106
|
-
| Status code | Description | Response headers |
|
|
1107
|
-
|-------------|-------------|------------------|
|
|
1108
|
-
|**200** | No Response | - |
|
|
1109
|
-
|**400** | Bad Request | - |
|
|
1110
|
-
|**401** | Unauthorised | - |
|
|
1111
|
-
|**403** | Access Denied | - |
|
|
1112
|
-
|
|
1113
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1114
|
-
|
|
1115
|
-
# **patchUpdateAccountCname**
|
|
1116
|
-
> patchUpdateAccountCname()
|
|
1117
|
-
|
|
1118
|
-
Set Account CNAME
|
|
1119
|
-
|
|
1120
|
-
### Example
|
|
1121
|
-
|
|
1122
|
-
```typescript
|
|
1123
|
-
import {
|
|
1124
|
-
AccountsApi,
|
|
1125
|
-
Configuration,
|
|
1126
|
-
PatchUpdateAccountCnameRequest
|
|
1127
|
-
} from 'yellowgrid-api-ts';
|
|
1128
|
-
|
|
1129
|
-
const configuration = new Configuration();
|
|
1130
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1131
|
-
|
|
1132
|
-
let id: string; //Xero ID (default to undefined)
|
|
1133
|
-
let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
|
|
1134
|
-
|
|
1135
|
-
const { status, data } = await apiInstance.patchUpdateAccountCname(
|
|
1136
|
-
id,
|
|
1137
|
-
patchUpdateAccountCnameRequest
|
|
1138
|
-
);
|
|
1139
|
-
```
|
|
1140
|
-
|
|
1141
|
-
### Parameters
|
|
1142
|
-
|
|
1143
|
-
|Name | Type | Description | Notes|
|
|
1144
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1145
|
-
| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
|
|
1146
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
### Return type
|
|
1150
|
-
|
|
1151
|
-
void (empty response body)
|
|
1152
|
-
|
|
1153
|
-
### Authorization
|
|
1154
|
-
|
|
1155
|
-
No authorization required
|
|
1156
|
-
|
|
1157
|
-
### HTTP request headers
|
|
1158
|
-
|
|
1159
|
-
- **Content-Type**: application/json
|
|
1160
|
-
- **Accept**: Not defined
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
### HTTP response details
|
|
1164
|
-
| Status code | Description | Response headers |
|
|
1165
|
-
|-------------|-------------|------------------|
|
|
1166
|
-
|**204** | No Response | - |
|
|
1167
|
-
|**400** | Bad Request | - |
|
|
1168
|
-
|**401** | Unauthorised | - |
|
|
1169
|
-
|**403** | Access Denied | - |
|
|
1170
|
-
|
|
1171
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1172
|
-
|
|
1173
|
-
# **patchUpdateAccountCompanyNumber**
|
|
1174
|
-
> patchUpdateAccountCompanyNumber()
|
|
1175
|
-
|
|
1176
|
-
Set Account Company Number
|
|
1177
|
-
|
|
1178
|
-
### Example
|
|
1179
|
-
|
|
1180
|
-
```typescript
|
|
1181
|
-
import {
|
|
1182
|
-
AccountsApi,
|
|
1183
|
-
Configuration,
|
|
1184
|
-
PatchUpdateAccountCompanyNumberRequest
|
|
1185
|
-
} from 'yellowgrid-api-ts';
|
|
1186
|
-
|
|
1187
|
-
const configuration = new Configuration();
|
|
1188
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1189
|
-
|
|
1190
|
-
let id: string; //Xero ID (default to undefined)
|
|
1191
|
-
let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
|
|
1192
|
-
|
|
1193
|
-
const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
|
|
1194
|
-
id,
|
|
1195
|
-
patchUpdateAccountCompanyNumberRequest
|
|
1196
|
-
);
|
|
1197
|
-
```
|
|
1198
|
-
|
|
1199
|
-
### Parameters
|
|
1200
|
-
|
|
1201
|
-
|Name | Type | Description | Notes|
|
|
1202
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1203
|
-
| **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
|
|
1204
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
### Return type
|
|
1208
|
-
|
|
1209
|
-
void (empty response body)
|
|
1210
|
-
|
|
1211
|
-
### Authorization
|
|
1212
|
-
|
|
1213
|
-
No authorization required
|
|
1214
|
-
|
|
1215
|
-
### HTTP request headers
|
|
1216
|
-
|
|
1217
|
-
- **Content-Type**: application/json
|
|
1218
|
-
- **Accept**: Not defined
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
### HTTP response details
|
|
1222
|
-
| Status code | Description | Response headers |
|
|
1223
|
-
|-------------|-------------|------------------|
|
|
1224
|
-
|**204** | No Response | - |
|
|
1225
|
-
|**400** | Bad Request | - |
|
|
1226
|
-
|**401** | Unauthorised | - |
|
|
1227
|
-
|**403** | Access Denied | - |
|
|
1228
|
-
|
|
1229
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1230
|
-
|
|
1231
|
-
# **patchUpdateAccountContactPassword**
|
|
1232
|
-
> patchUpdateAccountContactPassword()
|
|
1233
|
-
|
|
1234
|
-
Update Account Password
|
|
1235
|
-
|
|
1236
|
-
### Example
|
|
1237
|
-
|
|
1238
|
-
```typescript
|
|
1239
|
-
import {
|
|
1240
|
-
AccountsApi,
|
|
1241
|
-
Configuration,
|
|
1242
|
-
PatchUpdateAccountContactPasswordRequest
|
|
1243
|
-
} from 'yellowgrid-api-ts';
|
|
1244
|
-
|
|
1245
|
-
const configuration = new Configuration();
|
|
1246
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1247
|
-
|
|
1248
|
-
let token: string; //Verification Token (default to undefined)
|
|
1249
|
-
let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
|
|
1250
|
-
|
|
1251
|
-
const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
|
|
1252
|
-
token,
|
|
1253
|
-
patchUpdateAccountContactPasswordRequest
|
|
1254
|
-
);
|
|
1255
|
-
```
|
|
1256
|
-
|
|
1257
|
-
### Parameters
|
|
1258
|
-
|
|
1259
|
-
|Name | Type | Description | Notes|
|
|
1260
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1261
|
-
| **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
|
|
1262
|
-
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
### Return type
|
|
1266
|
-
|
|
1267
|
-
void (empty response body)
|
|
1268
|
-
|
|
1269
|
-
### Authorization
|
|
1270
|
-
|
|
1271
|
-
No authorization required
|
|
1272
|
-
|
|
1273
|
-
### HTTP request headers
|
|
1274
|
-
|
|
1275
|
-
- **Content-Type**: application/json
|
|
1276
|
-
- **Accept**: Not defined
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
### HTTP response details
|
|
1280
|
-
| Status code | Description | Response headers |
|
|
1281
|
-
|-------------|-------------|------------------|
|
|
1282
|
-
|**200** | No Response | - |
|
|
1283
|
-
|**400** | Bad Request | - |
|
|
1284
|
-
|**401** | Unauthorised | - |
|
|
1285
|
-
|**403** | Access Denied | - |
|
|
1286
|
-
|
|
1287
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1288
|
-
|
|
1289
|
-
# **patchUpdateAccountPhone**
|
|
1290
|
-
> patchUpdateAccountPhone()
|
|
1291
|
-
|
|
1292
|
-
Set Account Phone
|
|
1293
|
-
|
|
1294
|
-
### Example
|
|
1295
|
-
|
|
1296
|
-
```typescript
|
|
1297
|
-
import {
|
|
1298
|
-
AccountsApi,
|
|
1299
|
-
Configuration,
|
|
1300
|
-
PatchUpdateAccountPhoneRequest
|
|
1301
|
-
} from 'yellowgrid-api-ts';
|
|
1302
|
-
|
|
1303
|
-
const configuration = new Configuration();
|
|
1304
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1305
|
-
|
|
1306
|
-
let id: string; //Xero ID (default to undefined)
|
|
1307
|
-
let patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
|
|
1308
|
-
|
|
1309
|
-
const { status, data } = await apiInstance.patchUpdateAccountPhone(
|
|
1310
|
-
id,
|
|
1311
|
-
patchUpdateAccountPhoneRequest
|
|
1312
|
-
);
|
|
1313
|
-
```
|
|
1314
|
-
|
|
1315
|
-
### Parameters
|
|
1316
|
-
|
|
1317
|
-
|Name | Type | Description | Notes|
|
|
1318
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1319
|
-
| **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone Request | |
|
|
1320
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
### Return type
|
|
1324
|
-
|
|
1325
|
-
void (empty response body)
|
|
1326
|
-
|
|
1327
|
-
### Authorization
|
|
1328
|
-
|
|
1329
|
-
No authorization required
|
|
1330
|
-
|
|
1331
|
-
### HTTP request headers
|
|
1332
|
-
|
|
1333
|
-
- **Content-Type**: application/json
|
|
1334
|
-
- **Accept**: Not defined
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
### HTTP response details
|
|
1338
|
-
| Status code | Description | Response headers |
|
|
1339
|
-
|-------------|-------------|------------------|
|
|
1340
|
-
|**204** | No Response | - |
|
|
1341
|
-
|**400** | Bad Request | - |
|
|
1342
|
-
|**401** | Unauthorised | - |
|
|
1343
|
-
|**403** | Access Denied | - |
|
|
1344
|
-
|
|
1345
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1346
|
-
|
|
1347
|
-
# **patchUpdateAccountVatNumber**
|
|
1348
|
-
> patchUpdateAccountVatNumber()
|
|
1349
|
-
|
|
1350
|
-
Set Account VAT Number
|
|
1351
|
-
|
|
1352
|
-
### Example
|
|
1353
|
-
|
|
1354
|
-
```typescript
|
|
1355
|
-
import {
|
|
1356
|
-
AccountsApi,
|
|
1357
|
-
Configuration,
|
|
1358
|
-
PatchUpdateAccountVatNumberRequest
|
|
1359
|
-
} from 'yellowgrid-api-ts';
|
|
1360
|
-
|
|
1361
|
-
const configuration = new Configuration();
|
|
1362
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1363
|
-
|
|
1364
|
-
let id: string; //Xero ID (default to undefined)
|
|
1365
|
-
let patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
|
|
1366
|
-
|
|
1367
|
-
const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
|
|
1368
|
-
id,
|
|
1369
|
-
patchUpdateAccountVatNumberRequest
|
|
1370
|
-
);
|
|
1371
|
-
```
|
|
1372
|
-
|
|
1373
|
-
### Parameters
|
|
1374
|
-
|
|
1375
|
-
|Name | Type | Description | Notes|
|
|
1376
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1377
|
-
| **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
|
|
1378
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
### Return type
|
|
1382
|
-
|
|
1383
|
-
void (empty response body)
|
|
1384
|
-
|
|
1385
|
-
### Authorization
|
|
1386
|
-
|
|
1387
|
-
No authorization required
|
|
1388
|
-
|
|
1389
|
-
### HTTP request headers
|
|
1390
|
-
|
|
1391
|
-
- **Content-Type**: application/json
|
|
1392
|
-
- **Accept**: Not defined
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
### HTTP response details
|
|
1396
|
-
| Status code | Description | Response headers |
|
|
1397
|
-
|-------------|-------------|------------------|
|
|
1398
|
-
|**204** | No Response | - |
|
|
1399
|
-
|**400** | Bad Request | - |
|
|
1400
|
-
|**401** | Unauthorised | - |
|
|
1401
|
-
|**403** | Access Denied | - |
|
|
1402
|
-
|
|
1403
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1404
|
-
|
|
1405
|
-
# **patchUpdateCreditLimit**
|
|
1406
|
-
> AccountFinanceDTO patchUpdateCreditLimit()
|
|
1407
|
-
|
|
1408
|
-
Set Account Credit Limit
|
|
1409
|
-
|
|
1410
|
-
### Example
|
|
1411
|
-
|
|
1412
|
-
```typescript
|
|
1413
|
-
import {
|
|
1414
|
-
AccountsApi,
|
|
1415
|
-
Configuration,
|
|
1416
|
-
PatchUpdateCreditLimitRequest
|
|
1417
|
-
} from 'yellowgrid-api-ts';
|
|
1418
|
-
|
|
1419
|
-
const configuration = new Configuration();
|
|
1420
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1421
|
-
|
|
1422
|
-
let id: string; //Xero ID (default to undefined)
|
|
1423
|
-
let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
|
|
1424
|
-
|
|
1425
|
-
const { status, data } = await apiInstance.patchUpdateCreditLimit(
|
|
1426
|
-
id,
|
|
1427
|
-
patchUpdateCreditLimitRequest
|
|
1428
|
-
);
|
|
1429
|
-
```
|
|
1430
|
-
|
|
1431
|
-
### Parameters
|
|
1432
|
-
|
|
1433
|
-
|Name | Type | Description | Notes|
|
|
1434
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1435
|
-
| **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
|
|
1436
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
### Return type
|
|
1440
|
-
|
|
1441
|
-
**AccountFinanceDTO**
|
|
1442
|
-
|
|
1443
|
-
### Authorization
|
|
1444
|
-
|
|
1445
|
-
No authorization required
|
|
1446
|
-
|
|
1447
|
-
### HTTP request headers
|
|
1448
|
-
|
|
1449
|
-
- **Content-Type**: application/json
|
|
1450
|
-
- **Accept**: application/json
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
### HTTP response details
|
|
1454
|
-
| Status code | Description | Response headers |
|
|
1455
|
-
|-------------|-------------|------------------|
|
|
1456
|
-
|**200** | Accounts Finance Details | - |
|
|
1457
|
-
|**400** | Bad Request | - |
|
|
1458
|
-
|**401** | Unauthorised | - |
|
|
1459
|
-
|**403** | Access Denied | - |
|
|
1460
|
-
|
|
1461
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1462
|
-
|
|
1463
|
-
# **patchUpdatePriceList**
|
|
1464
|
-
> AccountFinanceDTO patchUpdatePriceList()
|
|
353
|
+
# **getGetClientCredentials**
|
|
354
|
+
> Array<ClientModel> getGetClientCredentials()
|
|
1465
355
|
|
|
1466
|
-
|
|
356
|
+
Get user\'s client credentials
|
|
1467
357
|
|
|
1468
358
|
### Example
|
|
1469
359
|
|
|
1470
360
|
```typescript
|
|
1471
361
|
import {
|
|
1472
362
|
AccountsApi,
|
|
1473
|
-
Configuration
|
|
1474
|
-
PatchUpdatePriceListRequest
|
|
363
|
+
Configuration
|
|
1475
364
|
} from 'yellowgrid-api-ts';
|
|
1476
365
|
|
|
1477
366
|
const configuration = new Configuration();
|
|
1478
367
|
const apiInstance = new AccountsApi(configuration);
|
|
1479
368
|
|
|
1480
|
-
|
|
1481
|
-
let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
|
|
1482
|
-
|
|
1483
|
-
const { status, data } = await apiInstance.patchUpdatePriceList(
|
|
1484
|
-
id,
|
|
1485
|
-
patchUpdatePriceListRequest
|
|
1486
|
-
);
|
|
369
|
+
const { status, data } = await apiInstance.getGetClientCredentials();
|
|
1487
370
|
```
|
|
1488
371
|
|
|
1489
372
|
### Parameters
|
|
1490
|
-
|
|
1491
|
-
|Name | Type | Description | Notes|
|
|
1492
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1493
|
-
| **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
|
|
1494
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
373
|
+
This endpoint does not have any parameters.
|
|
1495
374
|
|
|
1496
375
|
|
|
1497
376
|
### Return type
|
|
1498
377
|
|
|
1499
|
-
**
|
|
378
|
+
**Array<ClientModel>**
|
|
1500
379
|
|
|
1501
380
|
### Authorization
|
|
1502
381
|
|
|
@@ -1504,57 +383,46 @@ No authorization required
|
|
|
1504
383
|
|
|
1505
384
|
### HTTP request headers
|
|
1506
385
|
|
|
1507
|
-
- **Content-Type**:
|
|
386
|
+
- **Content-Type**: Not defined
|
|
1508
387
|
- **Accept**: application/json
|
|
1509
388
|
|
|
1510
389
|
|
|
1511
390
|
### HTTP response details
|
|
1512
391
|
| Status code | Description | Response headers |
|
|
1513
392
|
|-------------|-------------|------------------|
|
|
1514
|
-
|**200** |
|
|
393
|
+
|**200** | List of client credentials | - |
|
|
1515
394
|
|**400** | Bad Request | - |
|
|
1516
395
|
|**401** | Unauthorised | - |
|
|
1517
396
|
|**403** | Access Denied | - |
|
|
1518
397
|
|
|
1519
398
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1520
399
|
|
|
1521
|
-
# **
|
|
1522
|
-
>
|
|
400
|
+
# **getGetCustomerKeys**
|
|
401
|
+
> Array<TcxKeySummaryDTO> getGetCustomerKeys()
|
|
1523
402
|
|
|
1524
|
-
|
|
403
|
+
Get 3CX Keys
|
|
1525
404
|
|
|
1526
405
|
### Example
|
|
1527
406
|
|
|
1528
407
|
```typescript
|
|
1529
408
|
import {
|
|
1530
409
|
AccountsApi,
|
|
1531
|
-
Configuration
|
|
1532
|
-
PatchUpdateSipChannelCostRequest
|
|
410
|
+
Configuration
|
|
1533
411
|
} from 'yellowgrid-api-ts';
|
|
1534
412
|
|
|
1535
413
|
const configuration = new Configuration();
|
|
1536
414
|
const apiInstance = new AccountsApi(configuration);
|
|
1537
415
|
|
|
1538
|
-
|
|
1539
|
-
let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
|
|
1540
|
-
|
|
1541
|
-
const { status, data } = await apiInstance.patchUpdateSipChannelCost(
|
|
1542
|
-
id,
|
|
1543
|
-
patchUpdateSipChannelCostRequest
|
|
1544
|
-
);
|
|
416
|
+
const { status, data } = await apiInstance.getGetCustomerKeys();
|
|
1545
417
|
```
|
|
1546
418
|
|
|
1547
419
|
### Parameters
|
|
1548
|
-
|
|
1549
|
-
|Name | Type | Description | Notes|
|
|
1550
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1551
|
-
| **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
|
|
1552
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
420
|
+
This endpoint does not have any parameters.
|
|
1553
421
|
|
|
1554
422
|
|
|
1555
423
|
### Return type
|
|
1556
424
|
|
|
1557
|
-
**
|
|
425
|
+
**Array<TcxKeySummaryDTO>**
|
|
1558
426
|
|
|
1559
427
|
### Authorization
|
|
1560
428
|
|
|
@@ -1562,43 +430,40 @@ No authorization required
|
|
|
1562
430
|
|
|
1563
431
|
### HTTP request headers
|
|
1564
432
|
|
|
1565
|
-
- **Content-Type**:
|
|
433
|
+
- **Content-Type**: Not defined
|
|
1566
434
|
- **Accept**: application/json
|
|
1567
435
|
|
|
1568
436
|
|
|
1569
437
|
### HTTP response details
|
|
1570
438
|
| Status code | Description | Response headers |
|
|
1571
439
|
|-------------|-------------|------------------|
|
|
1572
|
-
|**200** |
|
|
440
|
+
|**200** | 3CX Key Summaries | - |
|
|
1573
441
|
|**400** | Bad Request | - |
|
|
1574
442
|
|**401** | Unauthorised | - |
|
|
1575
443
|
|**403** | Access Denied | - |
|
|
1576
444
|
|
|
1577
445
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1578
446
|
|
|
1579
|
-
# **
|
|
1580
|
-
>
|
|
447
|
+
# **getVerifyEmailAddress**
|
|
448
|
+
> getVerifyEmailAddress()
|
|
1581
449
|
|
|
1582
|
-
|
|
450
|
+
Verify account email address
|
|
1583
451
|
|
|
1584
452
|
### Example
|
|
1585
453
|
|
|
1586
454
|
```typescript
|
|
1587
455
|
import {
|
|
1588
456
|
AccountsApi,
|
|
1589
|
-
Configuration
|
|
1590
|
-
PatchUpdateTcxHostingPriceListRequest
|
|
457
|
+
Configuration
|
|
1591
458
|
} from 'yellowgrid-api-ts';
|
|
1592
459
|
|
|
1593
460
|
const configuration = new Configuration();
|
|
1594
461
|
const apiInstance = new AccountsApi(configuration);
|
|
1595
462
|
|
|
1596
|
-
let
|
|
1597
|
-
let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
|
|
463
|
+
let token: string; //Verification Token (default to undefined)
|
|
1598
464
|
|
|
1599
|
-
const { status, data } = await apiInstance.
|
|
1600
|
-
|
|
1601
|
-
patchUpdateTcxHostingPriceListRequest
|
|
465
|
+
const { status, data } = await apiInstance.getVerifyEmailAddress(
|
|
466
|
+
token
|
|
1602
467
|
);
|
|
1603
468
|
```
|
|
1604
469
|
|
|
@@ -1606,13 +471,12 @@ const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
|
|
|
1606
471
|
|
|
1607
472
|
|Name | Type | Description | Notes|
|
|
1608
473
|
|------------- | ------------- | ------------- | -------------|
|
|
1609
|
-
| **
|
|
1610
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
474
|
+
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1611
475
|
|
|
1612
476
|
|
|
1613
477
|
### Return type
|
|
1614
478
|
|
|
1615
|
-
|
|
479
|
+
void (empty response body)
|
|
1616
480
|
|
|
1617
481
|
### Authorization
|
|
1618
482
|
|
|
@@ -1620,24 +484,24 @@ No authorization required
|
|
|
1620
484
|
|
|
1621
485
|
### HTTP request headers
|
|
1622
486
|
|
|
1623
|
-
- **Content-Type**:
|
|
1624
|
-
- **Accept**:
|
|
487
|
+
- **Content-Type**: Not defined
|
|
488
|
+
- **Accept**: Not defined
|
|
1625
489
|
|
|
1626
490
|
|
|
1627
491
|
### HTTP response details
|
|
1628
492
|
| Status code | Description | Response headers |
|
|
1629
493
|
|-------------|-------------|------------------|
|
|
1630
|
-
|**200** |
|
|
494
|
+
|**200** | No Response | - |
|
|
1631
495
|
|**400** | Bad Request | - |
|
|
1632
496
|
|**401** | Unauthorised | - |
|
|
1633
497
|
|**403** | Access Denied | - |
|
|
1634
498
|
|
|
1635
499
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1636
500
|
|
|
1637
|
-
# **
|
|
1638
|
-
>
|
|
501
|
+
# **patchSetTcxWizardCname**
|
|
502
|
+
> patchSetTcxWizardCname()
|
|
1639
503
|
|
|
1640
|
-
Set
|
|
504
|
+
Set 3CX Wizard CNAME
|
|
1641
505
|
|
|
1642
506
|
### Example
|
|
1643
507
|
|
|
@@ -1645,18 +509,16 @@ Set Account 3CX Partner ID
|
|
|
1645
509
|
import {
|
|
1646
510
|
AccountsApi,
|
|
1647
511
|
Configuration,
|
|
1648
|
-
|
|
512
|
+
PatchSetTcxWizardCnameRequest
|
|
1649
513
|
} from 'yellowgrid-api-ts';
|
|
1650
514
|
|
|
1651
515
|
const configuration = new Configuration();
|
|
1652
516
|
const apiInstance = new AccountsApi(configuration);
|
|
1653
517
|
|
|
1654
|
-
let
|
|
1655
|
-
let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
|
|
518
|
+
let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
|
|
1656
519
|
|
|
1657
|
-
const { status, data } = await apiInstance.
|
|
1658
|
-
|
|
1659
|
-
patchUpdateTcxPartnerIdRequest
|
|
520
|
+
const { status, data } = await apiInstance.patchSetTcxWizardCname(
|
|
521
|
+
patchSetTcxWizardCnameRequest
|
|
1660
522
|
);
|
|
1661
523
|
```
|
|
1662
524
|
|
|
@@ -1664,13 +526,12 @@ const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
|
|
|
1664
526
|
|
|
1665
527
|
|Name | Type | Description | Notes|
|
|
1666
528
|
|------------- | ------------- | ------------- | -------------|
|
|
1667
|
-
| **
|
|
1668
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
529
|
+
| **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
|
|
1669
530
|
|
|
1670
531
|
|
|
1671
532
|
### Return type
|
|
1672
533
|
|
|
1673
|
-
|
|
534
|
+
void (empty response body)
|
|
1674
535
|
|
|
1675
536
|
### Authorization
|
|
1676
537
|
|
|
@@ -1679,23 +540,23 @@ No authorization required
|
|
|
1679
540
|
### HTTP request headers
|
|
1680
541
|
|
|
1681
542
|
- **Content-Type**: application/json
|
|
1682
|
-
- **Accept**:
|
|
543
|
+
- **Accept**: Not defined
|
|
1683
544
|
|
|
1684
545
|
|
|
1685
546
|
### HTTP response details
|
|
1686
547
|
| Status code | Description | Response headers |
|
|
1687
548
|
|-------------|-------------|------------------|
|
|
1688
|
-
|**200** |
|
|
549
|
+
|**200** | No Response | - |
|
|
1689
550
|
|**400** | Bad Request | - |
|
|
1690
551
|
|**401** | Unauthorised | - |
|
|
1691
552
|
|**403** | Access Denied | - |
|
|
1692
553
|
|
|
1693
554
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1694
555
|
|
|
1695
|
-
# **
|
|
1696
|
-
>
|
|
556
|
+
# **patchUpdateAccountContactPassword**
|
|
557
|
+
> patchUpdateAccountContactPassword()
|
|
1697
558
|
|
|
1698
|
-
|
|
559
|
+
Update Account Password
|
|
1699
560
|
|
|
1700
561
|
### Example
|
|
1701
562
|
|
|
@@ -1703,18 +564,18 @@ Create Account Contact
|
|
|
1703
564
|
import {
|
|
1704
565
|
AccountsApi,
|
|
1705
566
|
Configuration,
|
|
1706
|
-
|
|
567
|
+
PatchUpdateAccountContactPasswordRequest
|
|
1707
568
|
} from 'yellowgrid-api-ts';
|
|
1708
569
|
|
|
1709
570
|
const configuration = new Configuration();
|
|
1710
571
|
const apiInstance = new AccountsApi(configuration);
|
|
1711
572
|
|
|
1712
|
-
let
|
|
1713
|
-
let
|
|
573
|
+
let token: string; //Verification Token (default to undefined)
|
|
574
|
+
let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
|
|
1714
575
|
|
|
1715
|
-
const { status, data } = await apiInstance.
|
|
1716
|
-
|
|
1717
|
-
|
|
576
|
+
const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
|
|
577
|
+
token,
|
|
578
|
+
patchUpdateAccountContactPasswordRequest
|
|
1718
579
|
);
|
|
1719
580
|
```
|
|
1720
581
|
|
|
@@ -1722,8 +583,8 @@ const { status, data } = await apiInstance.postAdminCreateAccountContact(
|
|
|
1722
583
|
|
|
1723
584
|
|Name | Type | Description | Notes|
|
|
1724
585
|
|------------- | ------------- | ------------- | -------------|
|
|
1725
|
-
| **
|
|
1726
|
-
| **
|
|
586
|
+
| **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
|
|
587
|
+
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1727
588
|
|
|
1728
589
|
|
|
1729
590
|
### Return type
|
|
@@ -1743,7 +604,7 @@ No authorization required
|
|
|
1743
604
|
### HTTP response details
|
|
1744
605
|
| Status code | Description | Response headers |
|
|
1745
606
|
|-------------|-------------|------------------|
|
|
1746
|
-
|**
|
|
607
|
+
|**200** | No Response | - |
|
|
1747
608
|
|**400** | Bad Request | - |
|
|
1748
609
|
|**401** | Unauthorised | - |
|
|
1749
610
|
|**403** | Access Denied | - |
|
|
@@ -2060,64 +921,6 @@ No authorization required
|
|
|
2060
921
|
- **Accept**: Not defined
|
|
2061
922
|
|
|
2062
923
|
|
|
2063
|
-
### HTTP response details
|
|
2064
|
-
| Status code | Description | Response headers |
|
|
2065
|
-
|-------------|-------------|------------------|
|
|
2066
|
-
|**200** | No Response | - |
|
|
2067
|
-
|**400** | Bad Request | - |
|
|
2068
|
-
|**401** | Unauthorised | - |
|
|
2069
|
-
|**403** | Access Denied | - |
|
|
2070
|
-
|
|
2071
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2072
|
-
|
|
2073
|
-
# **postSendWelcomeEmail**
|
|
2074
|
-
> postSendWelcomeEmail()
|
|
2075
|
-
|
|
2076
|
-
Send Account Welcome Email
|
|
2077
|
-
|
|
2078
|
-
### Example
|
|
2079
|
-
|
|
2080
|
-
```typescript
|
|
2081
|
-
import {
|
|
2082
|
-
AccountsApi,
|
|
2083
|
-
Configuration,
|
|
2084
|
-
PostSendWelcomeEmailRequest
|
|
2085
|
-
} from 'yellowgrid-api-ts';
|
|
2086
|
-
|
|
2087
|
-
const configuration = new Configuration();
|
|
2088
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2089
|
-
|
|
2090
|
-
let id: string; //Xero ID (default to undefined)
|
|
2091
|
-
let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
|
|
2092
|
-
|
|
2093
|
-
const { status, data } = await apiInstance.postSendWelcomeEmail(
|
|
2094
|
-
id,
|
|
2095
|
-
postSendWelcomeEmailRequest
|
|
2096
|
-
);
|
|
2097
|
-
```
|
|
2098
|
-
|
|
2099
|
-
### Parameters
|
|
2100
|
-
|
|
2101
|
-
|Name | Type | Description | Notes|
|
|
2102
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2103
|
-
| **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
|
|
2104
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
### Return type
|
|
2108
|
-
|
|
2109
|
-
void (empty response body)
|
|
2110
|
-
|
|
2111
|
-
### Authorization
|
|
2112
|
-
|
|
2113
|
-
No authorization required
|
|
2114
|
-
|
|
2115
|
-
### HTTP request headers
|
|
2116
|
-
|
|
2117
|
-
- **Content-Type**: application/json
|
|
2118
|
-
- **Accept**: Not defined
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
924
|
### HTTP response details
|
|
2122
925
|
| Status code | Description | Response headers |
|
|
2123
926
|
|-------------|-------------|------------------|
|
|
@@ -2188,67 +991,6 @@ No authorization required
|
|
|
2188
991
|
|
|
2189
992
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2190
993
|
|
|
2191
|
-
# **putAdminUpdateAccountContact**
|
|
2192
|
-
> putAdminUpdateAccountContact()
|
|
2193
|
-
|
|
2194
|
-
Update Account Contact
|
|
2195
|
-
|
|
2196
|
-
### Example
|
|
2197
|
-
|
|
2198
|
-
```typescript
|
|
2199
|
-
import {
|
|
2200
|
-
AccountsApi,
|
|
2201
|
-
Configuration,
|
|
2202
|
-
AccountContactRequestModel
|
|
2203
|
-
} from 'yellowgrid-api-ts';
|
|
2204
|
-
|
|
2205
|
-
const configuration = new Configuration();
|
|
2206
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2207
|
-
|
|
2208
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
2209
|
-
let contactId: number; //Contact ID (default to undefined)
|
|
2210
|
-
let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
|
|
2211
|
-
|
|
2212
|
-
const { status, data } = await apiInstance.putAdminUpdateAccountContact(
|
|
2213
|
-
id,
|
|
2214
|
-
contactId,
|
|
2215
|
-
accountContactRequestModel
|
|
2216
|
-
);
|
|
2217
|
-
```
|
|
2218
|
-
|
|
2219
|
-
### Parameters
|
|
2220
|
-
|
|
2221
|
-
|Name | Type | Description | Notes|
|
|
2222
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2223
|
-
| **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
|
|
2224
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
2225
|
-
| **contactId** | [**number**] | Contact ID | defaults to undefined|
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
### Return type
|
|
2229
|
-
|
|
2230
|
-
void (empty response body)
|
|
2231
|
-
|
|
2232
|
-
### Authorization
|
|
2233
|
-
|
|
2234
|
-
No authorization required
|
|
2235
|
-
|
|
2236
|
-
### HTTP request headers
|
|
2237
|
-
|
|
2238
|
-
- **Content-Type**: application/json
|
|
2239
|
-
- **Accept**: Not defined
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
### HTTP response details
|
|
2243
|
-
| Status code | Description | Response headers |
|
|
2244
|
-
|-------------|-------------|------------------|
|
|
2245
|
-
|**204** | No Response | - |
|
|
2246
|
-
|**400** | Bad Request | - |
|
|
2247
|
-
|**401** | Unauthorised | - |
|
|
2248
|
-
|**403** | Access Denied | - |
|
|
2249
|
-
|
|
2250
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2251
|
-
|
|
2252
994
|
# **putUpdateAccountContact**
|
|
2253
995
|
> putUpdateAccountContact()
|
|
2254
996
|
|
|
@@ -2307,119 +1049,3 @@ No authorization required
|
|
|
2307
1049
|
|
|
2308
1050
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2309
1051
|
|
|
2310
|
-
# **putUpdateBillingAddress**
|
|
2311
|
-
> putUpdateBillingAddress()
|
|
2312
|
-
|
|
2313
|
-
Update Account Billing Address
|
|
2314
|
-
|
|
2315
|
-
### Example
|
|
2316
|
-
|
|
2317
|
-
```typescript
|
|
2318
|
-
import {
|
|
2319
|
-
AccountsApi,
|
|
2320
|
-
Configuration,
|
|
2321
|
-
AddressDTO
|
|
2322
|
-
} from 'yellowgrid-api-ts';
|
|
2323
|
-
|
|
2324
|
-
const configuration = new Configuration();
|
|
2325
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2326
|
-
|
|
2327
|
-
let id: string; //Xero ID (default to undefined)
|
|
2328
|
-
let addressDTO: AddressDTO; //Updated Billing Address (optional)
|
|
2329
|
-
|
|
2330
|
-
const { status, data } = await apiInstance.putUpdateBillingAddress(
|
|
2331
|
-
id,
|
|
2332
|
-
addressDTO
|
|
2333
|
-
);
|
|
2334
|
-
```
|
|
2335
|
-
|
|
2336
|
-
### Parameters
|
|
2337
|
-
|
|
2338
|
-
|Name | Type | Description | Notes|
|
|
2339
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2340
|
-
| **addressDTO** | **AddressDTO**| Updated Billing Address | |
|
|
2341
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
### Return type
|
|
2345
|
-
|
|
2346
|
-
void (empty response body)
|
|
2347
|
-
|
|
2348
|
-
### Authorization
|
|
2349
|
-
|
|
2350
|
-
No authorization required
|
|
2351
|
-
|
|
2352
|
-
### HTTP request headers
|
|
2353
|
-
|
|
2354
|
-
- **Content-Type**: application/json
|
|
2355
|
-
- **Accept**: Not defined
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
### HTTP response details
|
|
2359
|
-
| Status code | Description | Response headers |
|
|
2360
|
-
|-------------|-------------|------------------|
|
|
2361
|
-
|**204** | No Response | - |
|
|
2362
|
-
|**400** | Bad Request | - |
|
|
2363
|
-
|**401** | Unauthorised | - |
|
|
2364
|
-
|**403** | Access Denied | - |
|
|
2365
|
-
|
|
2366
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2367
|
-
|
|
2368
|
-
# **putUpdateShippingAddress**
|
|
2369
|
-
> putUpdateShippingAddress()
|
|
2370
|
-
|
|
2371
|
-
Update Account Shipping Address
|
|
2372
|
-
|
|
2373
|
-
### Example
|
|
2374
|
-
|
|
2375
|
-
```typescript
|
|
2376
|
-
import {
|
|
2377
|
-
AccountsApi,
|
|
2378
|
-
Configuration,
|
|
2379
|
-
AddressDTO
|
|
2380
|
-
} from 'yellowgrid-api-ts';
|
|
2381
|
-
|
|
2382
|
-
const configuration = new Configuration();
|
|
2383
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2384
|
-
|
|
2385
|
-
let id: string; //Xero ID (default to undefined)
|
|
2386
|
-
let addressDTO: AddressDTO; //Updated Shipping Address (optional)
|
|
2387
|
-
|
|
2388
|
-
const { status, data } = await apiInstance.putUpdateShippingAddress(
|
|
2389
|
-
id,
|
|
2390
|
-
addressDTO
|
|
2391
|
-
);
|
|
2392
|
-
```
|
|
2393
|
-
|
|
2394
|
-
### Parameters
|
|
2395
|
-
|
|
2396
|
-
|Name | Type | Description | Notes|
|
|
2397
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2398
|
-
| **addressDTO** | **AddressDTO**| Updated Shipping Address | |
|
|
2399
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
### Return type
|
|
2403
|
-
|
|
2404
|
-
void (empty response body)
|
|
2405
|
-
|
|
2406
|
-
### Authorization
|
|
2407
|
-
|
|
2408
|
-
No authorization required
|
|
2409
|
-
|
|
2410
|
-
### HTTP request headers
|
|
2411
|
-
|
|
2412
|
-
- **Content-Type**: application/json
|
|
2413
|
-
- **Accept**: Not defined
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
### HTTP response details
|
|
2417
|
-
| Status code | Description | Response headers |
|
|
2418
|
-
|-------------|-------------|------------------|
|
|
2419
|
-
|**204** | No Response | - |
|
|
2420
|
-
|**400** | Bad Request | - |
|
|
2421
|
-
|**401** | Unauthorised | - |
|
|
2422
|
-
|**403** | Access Denied | - |
|
|
2423
|
-
|
|
2424
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2425
|
-
|