yellowgrid-api-ts 3.2.143-dev.0 → 3.2.144-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 +269 -282
- package/.openapi-generator/VERSION +1 -1
- package/.openapi-generator-ignore +0 -0
- package/README.md +8 -41
- package/api.ts +5187 -2218
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +0 -0
- package/configuration.ts +19 -25
- package/dist/api.d.ts +4665 -1070
- package/dist/api.js +867 -2296
- 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 +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/CourierEnum.d.ts +0 -0
- package/dist/models/CourierEnum.js +0 -0
- package/dist/models/EventStatusEnum.d.ts +0 -0
- package/dist/models/EventStatusEnum.js +0 -0
- package/dist/models/EventTypeEnum.d.ts +0 -0
- package/dist/models/EventTypeEnum.js +0 -0
- package/dist/models/PortStatusEnum.d.ts +0 -0
- package/dist/models/PortStatusEnum.js +0 -0
- package/dist/models/PrinterEnum.d.ts +0 -0
- package/dist/models/PrinterEnum.js +0 -0
- package/dist/models/ScheduledTaskEnum.d.ts +0 -0
- package/dist/models/ScheduledTaskEnum.js +0 -0
- package/dist/models/ServiceEnum.d.ts +0 -0
- package/dist/models/ServiceEnum.js +0 -0
- package/dist/models/ServiceHealthEnum.d.ts +0 -0
- package/dist/models/ServiceHealthEnum.js +0 -0
- package/dist/models/ServiceStatusEnum.d.ts +0 -0
- package/dist/models/ServiceStatusEnum.js +0 -0
- package/dist/models/UpdateTypeEnum.d.ts +0 -0
- package/dist/models/UpdateTypeEnum.js +0 -0
- package/docs/AbstractOrderRequestDTO.md +0 -0
- package/docs/AccountContactEntity.md +0 -0
- package/docs/AccountContactModel.md +0 -0
- package/docs/AccountContactRequestModel.md +0 -0
- package/docs/AccountDetailedSummaryDTO.md +0 -0
- package/docs/AccountRequestModel.md +0 -0
- package/docs/AccountSummaryDTO.md +0 -0
- package/docs/AccountsApi.md +52 -1157
- package/docs/AccountsResponseModel.md +0 -0
- package/docs/AddressModel.md +0 -0
- package/docs/AddressRequestModel.md +0 -0
- package/docs/AdminNumberPortDTO.md +0 -0
- package/docs/AdminOrderRequestDTO.md +0 -0
- package/docs/AdminUserModel.md +0 -2
- package/docs/AgentHoursGraphModel.md +0 -0
- package/docs/AgentHoursGraphMonthModel.md +0 -0
- package/docs/ApiLogEntity.md +0 -0
- package/docs/AreaCodeModel.md +0 -0
- package/docs/AttachmentModel.md +0 -0
- package/docs/AttributeSetEnum.md +0 -0
- package/docs/AuditLogEntity.md +0 -0
- package/docs/AuthCodeResponseModel.md +0 -0
- package/docs/BasicItemDTO.md +0 -0
- package/docs/BasicProductDTO.md +0 -0
- package/docs/BatchDTO.md +0 -0
- package/docs/BatchEntity.md +0 -0
- package/docs/CRMApi.md +1 -121
- package/docs/CallBarringModel.md +0 -0
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ClientDetailsModel.md +0 -0
- package/docs/ClientModel.md +0 -0
- package/docs/CompanyContractModel.md +0 -0
- package/docs/ContactInfoModel.md +0 -0
- package/docs/ConversationModel.md +0 -0
- package/docs/CourierPriceEntity.md +0 -0
- package/docs/CreditAccountEntity.md +0 -0
- package/docs/CreditNoteDTO.md +0 -0
- package/docs/CreditNoteEntity.md +0 -0
- package/docs/CreditNoteItemDTO.md +0 -0
- package/docs/CreditNoteItemEntity.md +0 -0
- package/docs/CreditNoteItemModel.md +0 -0
- package/docs/CreditNoteModel.md +0 -0
- package/docs/CrmContactDTO.md +0 -0
- package/docs/CustomerInformationModel.md +0 -0
- package/docs/CustomerItemRequestDTO.md +0 -0
- package/docs/CustomerOrderRequestDTO.md +0 -0
- package/docs/CustomerPriceListEnum.md +0 -0
- package/docs/CustomerSummaryReportDTO.md +0 -0
- package/docs/DdiRangeRequestModel.md +0 -0
- package/docs/DdiRangesRequestModel.md +0 -0
- package/docs/DetailedItemRequestDTO.md +0 -0
- package/docs/DetailedOrderRequestDTO.md +0 -0
- package/docs/DivertRequestModel.md +0 -0
- package/docs/DivertResponseModel.md +0 -0
- package/docs/EdTechProClientEntity.md +0 -0
- package/docs/EdTechProSchoolModel.md +0 -0
- package/docs/EdTechProSchoolsModel.md +0 -0
- package/docs/EdTechProSetupModel.md +0 -0
- package/docs/EventDTO.md +0 -0
- package/docs/EventRequestDTO.md +0 -0
- package/docs/EventSubscriptionModel.md +0 -0
- package/docs/EventUpdateDTO.md +0 -0
- package/docs/EventUpdateEntity.md +0 -0
- package/docs/EventUpdateRequestDTO.md +0 -0
- package/docs/FraudManagementModel.md +0 -0
- package/docs/FreshdeskCompanyTicketsModel.md +0 -0
- package/docs/FreshdeskTicketEntity.md +0 -0
- package/docs/FtpAccountsEntity.md +0 -0
- package/docs/GenericFileModel.md +0 -0
- package/docs/GetGetPrice200Response.md +0 -0
- package/docs/GetGetRecording200Response.md +0 -0
- package/docs/HostingChangeResponseModel.md +0 -0
- package/docs/HostingRegionDTO.md +0 -0
- package/docs/InstallationDetailsDTO.md +0 -0
- package/docs/InstanceAutoFailoverEntity.md +0 -0
- package/docs/InstanceDeletionScheduleEntity.md +0 -0
- package/docs/InstanceEntity.md +0 -0
- package/docs/InstanceFailoverEntity.md +0 -0
- package/docs/InstanceMonitoringEntity.md +0 -0
- package/docs/InstanceMonitoringLogEntity.md +0 -0
- package/docs/InstanceScheduledTasksEntity.md +0 -0
- package/docs/InstanceTcxDetailsEntity.md +0 -0
- package/docs/InstanceUserCredentialsEntity.md +0 -0
- package/docs/ItemDTO.md +0 -0
- package/docs/ItemDiscountEntity.md +0 -0
- package/docs/ItemEntity.md +0 -0
- package/docs/LinkedOrderEntity.md +0 -0
- package/docs/MFARequiredModel.md +0 -0
- package/docs/MonthlyUsageModel.md +0 -0
- package/docs/MultiTenantChangeResponseModel.md +0 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NavigationModel.md +0 -0
- package/docs/NumberPortDTO.md +0 -0
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortNoteDTO.md +0 -0
- package/docs/NumberPortRangeDTO.md +0 -0
- package/docs/NumberPortRangeRequestDTO.md +0 -0
- package/docs/NumberPortingApi.md +6 -6
- package/docs/NumberPortsModel.md +0 -0
- package/docs/OAuth20Api.md +1 -1
- package/docs/OfflineInstancesEntity.md +0 -0
- package/docs/OrderDTO.md +25 -0
- package/docs/OrderDetailsDTO.md +0 -0
- package/docs/OrderEntity.md +0 -0
- package/docs/OrderItemDTO.md +0 -0
- package/docs/OrderRequestModel.md +0 -0
- package/docs/OrderResponseDTO.md +25 -0
- package/docs/OrderSummariesModel.md +0 -0
- package/docs/OrderSummaryDTO.md +0 -0
- package/docs/OrderTotalModel.md +0 -0
- package/docs/OrderedItemEntity.md +0 -0
- package/docs/OrderedItemModel.md +0 -0
- package/docs/OrdersApi.md +57 -1
- package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
- package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
- package/docs/PortalAccountModel.md +0 -0
- package/docs/PortalLoginModel.md +0 -0
- package/docs/PostAddAdminNoteRequest.md +0 -0
- package/docs/PostAddOrderNoteRequest.md +0 -0
- package/docs/PostAddWebhook200Response.md +0 -0
- package/docs/PostGetClientCredentialsRequest.md +0 -0
- package/docs/PostGetProductForCustomerRequest.md +2 -0
- package/docs/PostGetProductRequest.md +0 -0
- package/docs/PostSplitOrderRequest.md +0 -0
- package/docs/PriceListItemModel.md +0 -0
- package/docs/PricingApi.md +1 -1
- package/docs/PrinterEntity.md +0 -0
- package/docs/PrizesEntity.md +0 -0
- package/docs/ProductPriceListItemModel.md +0 -0
- package/docs/ProductSearchResultsModel.md +0 -0
- package/docs/ProductSerialInfoModel.md +0 -0
- package/docs/ProductSummaryDTO.md +0 -0
- package/docs/ProductsApi.md +6 -6
- package/docs/PromoCodesEntity.md +0 -0
- package/docs/PromoItemsEntity.md +0 -0
- package/docs/ProspectDTO.md +0 -2
- package/docs/ProspectEntity.md +0 -0
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/ProvisioningModel.md +0 -0
- package/docs/ProvisioningRequestEntity.md +0 -0
- package/docs/PutAllocateItemsRequest.md +0 -0
- package/docs/PutAllocateItemsRequestItemsInner.md +0 -0
- package/docs/RecordingBackupAzureModel.md +0 -0
- package/docs/RecordingsBackupInfoDTO.md +0 -0
- package/docs/RemoteStorageDTO.md +0 -0
- package/docs/ResourceNotReadyException.md +0 -0
- package/docs/RootAccessModel.md +0 -0
- package/docs/S3BucketEntity.md +0 -0
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/SbcDTO.md +35 -0
- package/docs/ScannedItemModel.md +0 -0
- package/docs/ScopeModel.md +0 -0
- package/docs/ServiceHealthDTO.md +0 -0
- package/docs/ServiceStatusDTO.md +0 -0
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentAddressEntity.md +0 -0
- package/docs/ShipmentDTO.md +0 -0
- package/docs/ShipmentEntity.md +0 -0
- package/docs/ShipmentItemDTO.md +0 -0
- package/docs/ShipmentItemEntity.md +0 -0
- package/docs/ShipmentItemModel.md +0 -0
- package/docs/ShipmentModel.md +0 -0
- package/docs/ShipmentRequestDTO.md +0 -0
- package/docs/ShippingAddressDTO.md +35 -0
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingConsignmentModel.md +0 -0
- package/docs/ShippingInformationDTO.md +0 -0
- package/docs/ShippingRequestDTO.md +0 -0
- package/docs/ShippingServiceDTO.md +0 -0
- package/docs/ShippingServiceModel.md +0 -0
- package/docs/ShippingServicesModel.md +0 -0
- package/docs/SipTrunkChangeResponseModel.md +0 -0
- package/docs/SipTrunkCreationRequestModel.md +0 -0
- package/docs/SipTrunkEntity.md +0 -0
- package/docs/SipTrunksResponseModel.md +0 -0
- package/docs/SmsAccountDTO.md +0 -0
- package/docs/SmsAccountEntity.md +0 -0
- package/docs/SmsAccountRequestDTO.md +0 -0
- package/docs/SmsDataModel.md +0 -0
- package/docs/SmsMessageModel.md +0 -0
- package/docs/SmsNumbersEntity.md +0 -0
- package/docs/SmsPayloadModel.md +0 -0
- package/docs/SmsPhoneNumberModel.md +0 -0
- package/docs/SmsResponseModel.md +0 -0
- package/docs/SmsWhitelistEntity.md +0 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockOrderCourierEntity.md +0 -0
- package/docs/StockOrderDeductionModel.md +0 -0
- package/docs/StockOrderDeductionRequestModel.md +0 -0
- package/docs/StockOrderDeductionsEntity.md +0 -0
- package/docs/StockOrderEntity.md +0 -0
- package/docs/StockOrderItemEntity.md +0 -0
- package/docs/StockOrderItemModel.md +0 -0
- package/docs/StockOrderItemRequestModel.md +0 -0
- package/docs/StockOrderModel.md +0 -0
- package/docs/StockOrderProductEntity.md +0 -0
- package/docs/StockOrderRequestModel.md +0 -0
- package/docs/StockOrderSupplierEntity.md +0 -0
- package/docs/StockOrderSupplierModel.md +0 -0
- package/docs/StockOrdersModel.md +0 -0
- package/docs/StockProductModel.md +0 -0
- package/docs/StockProductPriceModel.md +0 -0
- package/docs/StockProductSummariesModel.md +0 -0
- package/docs/StockProductSummaryModel.md +0 -0
- package/docs/StockTransactionsEntity.md +0 -0
- package/docs/SupplierEntity.md +0 -0
- package/docs/SupplierItemEntity.md +0 -0
- package/docs/SupplierItemModel.md +0 -0
- package/docs/SupplierModel.md +0 -0
- package/docs/SupportTicketModel.md +0 -0
- package/docs/SystemApi.md +1 -1
- package/docs/TcxBackupEntity.md +0 -0
- package/docs/TcxBackupModel.md +0 -0
- package/docs/TcxBillingEntity.md +0 -0
- package/docs/TcxBulkLicenceDetailsModel.md +0 -0
- package/docs/TcxDeadLicenceEntity.md +0 -0
- package/docs/TcxExtsEntity.md +0 -0
- package/docs/TcxHostingPricingEntity.md +0 -0
- package/docs/TcxInstallationDetailsModel.md +0 -0
- package/docs/TcxInstallationModel.md +0 -0
- package/docs/TcxInstallationsModel.md +0 -0
- package/docs/TcxKeySummaryDTO.md +0 -0
- package/docs/TcxKeysEntity.md +0 -0
- package/docs/TcxLicenceDetailsErrorModel.md +0 -0
- package/docs/TcxLicenceDetailsModel.md +0 -0
- package/docs/TcxMacsEntity.md +0 -0
- package/docs/TcxMultiTenantModel.md +0 -0
- package/docs/TcxMultiTenantUserModel.md +0 -0
- package/docs/TcxMultiTenantsModel.md +0 -0
- package/docs/TcxNumbersEntity.md +0 -0
- package/docs/TcxOfficeHoursEntity.md +0 -0
- package/docs/TcxPhoneModel.md +0 -0
- package/docs/TcxPhonesEntity.md +0 -0
- package/docs/TcxRemoteStorageModel.md +0 -0
- package/docs/TcxSbcDTO.md +0 -0
- package/docs/TcxSbcEntity.md +0 -0
- package/docs/TcxSbcModel.md +0 -0
- package/docs/TcxSbcResponseDTO.md +0 -0
- package/docs/TcxSetupEntity.md +0 -0
- package/docs/TcxSetupsModel.md +0 -0
- package/docs/TcxSipTrunksEntity.md +0 -0
- package/docs/TcxTemplateXmlEnum.md +0 -0
- package/docs/TcxUsersEntity.md +0 -0
- package/docs/TcxWizardConfigModel.md +0 -0
- package/docs/TcxWizardModel.md +0 -0
- package/docs/TechSupportCompanySummaryDTO.md +0 -0
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketSummaryModel.md +0 -0
- package/docs/TicketTimeDTO.md +0 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/TokenResponseModel.md +0 -0
- package/docs/UpgradeOrderResponseModel.md +0 -0
- package/docs/UpgradeRequestModel.md +0 -0
- package/docs/UserEntity.md +0 -0
- package/docs/WebhooksApi.md +1 -1
- package/docs/XeroLogEntity.md +0 -0
- package/getEnums.php +0 -0
- package/git_push.sh +0 -0
- 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/CourierEnum.ts +0 -0
- package/models/EventStatusEnum.ts +0 -0
- package/models/EventTypeEnum.ts +0 -0
- package/models/PortStatusEnum.ts +0 -0
- package/models/PrinterEnum.ts +0 -0
- package/models/ScheduledTaskEnum.ts +0 -0
- package/models/ServiceEnum.ts +0 -0
- package/models/ServiceHealthEnum.ts +0 -0
- package/models/ServiceStatusEnum.ts +0 -0
- package/models/UpdateTypeEnum.ts +0 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tsconfig.json +0 -0
- 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/AccountFinanceDTO.md +0 -37
- package/docs/AccountPageDetailsDTO.md +0 -41
- package/docs/AddressDTO.md +0 -31
- package/docs/CreateCrmNoteBody.md +0 -20
- 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/NumberPortAdminNoteBody.md +0 -20
- package/docs/PatchSendWelcomeEmailRequest.md +0 -20
- package/docs/PatchUpdateAccountCnameRequest.md +0 -20
- 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/PostCreateCrmNoteRequest.md +0 -20
- package/docs/PostSendWelcomeEmailRequest.md +0 -20
package/docs/AccountsApi.md
CHANGED
|
@@ -1,158 +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
10
|
|[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
|
|
14
11
|
|[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
|
|
15
|
-
|[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
|
|
16
12
|
|[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
|
|
17
13
|
|[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
|
|
18
14
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
19
|
-
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
20
15
|
|[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
|
|
21
|
-
|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
|
|
22
|
-
|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
|
|
23
16
|
|[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
|
|
24
|
-
|[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
|
|
25
|
-
|[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
|
|
26
17
|
|[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
|
|
27
|
-
|[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
|
|
28
|
-
|[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
|
|
29
|
-
|[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
|
|
30
|
-
|[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
|
|
31
|
-
|[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
|
|
32
|
-
|[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
|
|
33
18
|
|[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
|
|
34
19
|
|[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
|
|
35
20
|
|[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
|
|
36
21
|
|[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
|
|
37
22
|
|[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
|
|
38
23
|
|[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
|
|
39
|
-
|[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
|
|
40
24
|
|[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
|
|
41
|
-
|[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
|
|
42
25
|
|[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
|
|
43
|
-
|[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
|
|
44
|
-
|[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
|
|
45
|
-
|
|
46
|
-
# **deleteAdminUpdateAccountContact**
|
|
47
|
-
> deleteAdminUpdateAccountContact()
|
|
48
|
-
|
|
49
|
-
Delete Account Contact
|
|
50
|
-
|
|
51
|
-
### Example
|
|
52
|
-
|
|
53
|
-
```typescript
|
|
54
|
-
import {
|
|
55
|
-
AccountsApi,
|
|
56
|
-
Configuration
|
|
57
|
-
} from 'yellowgrid-api-ts';
|
|
58
|
-
|
|
59
|
-
const configuration = new Configuration();
|
|
60
|
-
const apiInstance = new AccountsApi(configuration);
|
|
61
|
-
|
|
62
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
63
|
-
let contactId: number; //Contact ID (default to undefined)
|
|
64
|
-
|
|
65
|
-
const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
|
|
66
|
-
id,
|
|
67
|
-
contactId
|
|
68
|
-
);
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Parameters
|
|
72
|
-
|
|
73
|
-
|Name | Type | Description | Notes|
|
|
74
|
-
|------------- | ------------- | ------------- | -------------|
|
|
75
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
76
|
-
| **contactId** | [**number**] | Contact ID | defaults to undefined|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
### Return type
|
|
80
|
-
|
|
81
|
-
void (empty response body)
|
|
82
|
-
|
|
83
|
-
### Authorization
|
|
84
|
-
|
|
85
|
-
No authorization required
|
|
86
|
-
|
|
87
|
-
### HTTP request headers
|
|
88
|
-
|
|
89
|
-
- **Content-Type**: Not defined
|
|
90
|
-
- **Accept**: Not defined
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
### HTTP response details
|
|
94
|
-
| Status code | Description | Response headers |
|
|
95
|
-
|-------------|-------------|------------------|
|
|
96
|
-
|**204** | No Response | - |
|
|
97
|
-
|**400** | Bad Request | - |
|
|
98
|
-
|**401** | Unauthorised | - |
|
|
99
|
-
|**403** | Access Denied | - |
|
|
100
|
-
|
|
101
|
-
[[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)
|
|
102
|
-
|
|
103
|
-
# **deleteArchiveAccount**
|
|
104
|
-
> deleteArchiveAccount()
|
|
105
|
-
|
|
106
|
-
Delete Account
|
|
107
|
-
|
|
108
|
-
### Example
|
|
109
|
-
|
|
110
|
-
```typescript
|
|
111
|
-
import {
|
|
112
|
-
AccountsApi,
|
|
113
|
-
Configuration
|
|
114
|
-
} from 'yellowgrid-api-ts';
|
|
115
|
-
|
|
116
|
-
const configuration = new Configuration();
|
|
117
|
-
const apiInstance = new AccountsApi(configuration);
|
|
118
|
-
|
|
119
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
120
|
-
|
|
121
|
-
const { status, data } = await apiInstance.deleteArchiveAccount(
|
|
122
|
-
id
|
|
123
|
-
);
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Parameters
|
|
127
|
-
|
|
128
|
-
|Name | Type | Description | Notes|
|
|
129
|
-
|------------- | ------------- | ------------- | -------------|
|
|
130
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
### Return type
|
|
134
|
-
|
|
135
|
-
void (empty response body)
|
|
136
|
-
|
|
137
|
-
### Authorization
|
|
138
|
-
|
|
139
|
-
No authorization required
|
|
140
|
-
|
|
141
|
-
### HTTP request headers
|
|
142
|
-
|
|
143
|
-
- **Content-Type**: Not defined
|
|
144
|
-
- **Accept**: Not defined
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
### HTTP response details
|
|
148
|
-
| Status code | Description | Response headers |
|
|
149
|
-
|-------------|-------------|------------------|
|
|
150
|
-
|**204** | No Response | - |
|
|
151
|
-
|**400** | Bad Request | - |
|
|
152
|
-
|**401** | Unauthorised | - |
|
|
153
|
-
|**403** | Access Denied | - |
|
|
154
|
-
|
|
155
|
-
[[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)
|
|
156
26
|
|
|
157
27
|
# **deleteDeleteClientCredentials**
|
|
158
28
|
> deleteDeleteClientCredentials()
|
|
@@ -262,60 +132,6 @@ No authorization required
|
|
|
262
132
|
|
|
263
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)
|
|
264
134
|
|
|
265
|
-
# **getAdminCreateAccountContact**
|
|
266
|
-
> Array<AccountContactModel> getAdminCreateAccountContact()
|
|
267
|
-
|
|
268
|
-
Get Account Contacts
|
|
269
|
-
|
|
270
|
-
### Example
|
|
271
|
-
|
|
272
|
-
```typescript
|
|
273
|
-
import {
|
|
274
|
-
AccountsApi,
|
|
275
|
-
Configuration
|
|
276
|
-
} from 'yellowgrid-api-ts';
|
|
277
|
-
|
|
278
|
-
const configuration = new Configuration();
|
|
279
|
-
const apiInstance = new AccountsApi(configuration);
|
|
280
|
-
|
|
281
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
282
|
-
|
|
283
|
-
const { status, data } = await apiInstance.getAdminCreateAccountContact(
|
|
284
|
-
id
|
|
285
|
-
);
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
### Parameters
|
|
289
|
-
|
|
290
|
-
|Name | Type | Description | Notes|
|
|
291
|
-
|------------- | ------------- | ------------- | -------------|
|
|
292
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
### Return type
|
|
296
|
-
|
|
297
|
-
**Array<AccountContactModel>**
|
|
298
|
-
|
|
299
|
-
### Authorization
|
|
300
|
-
|
|
301
|
-
No authorization required
|
|
302
|
-
|
|
303
|
-
### HTTP request headers
|
|
304
|
-
|
|
305
|
-
- **Content-Type**: Not defined
|
|
306
|
-
- **Accept**: application/json
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
### HTTP response details
|
|
310
|
-
| Status code | Description | Response headers |
|
|
311
|
-
|-------------|-------------|------------------|
|
|
312
|
-
|**200** | Account | - |
|
|
313
|
-
|**400** | Bad Request | - |
|
|
314
|
-
|**401** | Unauthorised | - |
|
|
315
|
-
|**403** | Access Denied | - |
|
|
316
|
-
|
|
317
|
-
[[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)
|
|
318
|
-
|
|
319
135
|
# **getGetAccount**
|
|
320
136
|
> PortalAccountModel getGetAccount()
|
|
321
137
|
|
|
@@ -471,60 +287,6 @@ No authorization required
|
|
|
471
287
|
|
|
472
288
|
[[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)
|
|
473
289
|
|
|
474
|
-
# **getGetAccountPageInfo**
|
|
475
|
-
> AccountPageDetailsDTO getGetAccountPageInfo()
|
|
476
|
-
|
|
477
|
-
Get Account Page Details
|
|
478
|
-
|
|
479
|
-
### Example
|
|
480
|
-
|
|
481
|
-
```typescript
|
|
482
|
-
import {
|
|
483
|
-
AccountsApi,
|
|
484
|
-
Configuration
|
|
485
|
-
} from 'yellowgrid-api-ts';
|
|
486
|
-
|
|
487
|
-
const configuration = new Configuration();
|
|
488
|
-
const apiInstance = new AccountsApi(configuration);
|
|
489
|
-
|
|
490
|
-
let id: string; //Xero ID (default to undefined)
|
|
491
|
-
|
|
492
|
-
const { status, data } = await apiInstance.getGetAccountPageInfo(
|
|
493
|
-
id
|
|
494
|
-
);
|
|
495
|
-
```
|
|
496
|
-
|
|
497
|
-
### Parameters
|
|
498
|
-
|
|
499
|
-
|Name | Type | Description | Notes|
|
|
500
|
-
|------------- | ------------- | ------------- | -------------|
|
|
501
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
### Return type
|
|
505
|
-
|
|
506
|
-
**AccountPageDetailsDTO**
|
|
507
|
-
|
|
508
|
-
### Authorization
|
|
509
|
-
|
|
510
|
-
No authorization required
|
|
511
|
-
|
|
512
|
-
### HTTP request headers
|
|
513
|
-
|
|
514
|
-
- **Content-Type**: Not defined
|
|
515
|
-
- **Accept**: application/json
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
### HTTP response details
|
|
519
|
-
| Status code | Description | Response headers |
|
|
520
|
-
|-------------|-------------|------------------|
|
|
521
|
-
|**200** | Accounts Page Details | - |
|
|
522
|
-
|**400** | Bad Request | - |
|
|
523
|
-
|**401** | Unauthorised | - |
|
|
524
|
-
|**403** | Access Denied | - |
|
|
525
|
-
|
|
526
|
-
[[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)
|
|
527
|
-
|
|
528
290
|
# **getGetAccounts**
|
|
529
291
|
> AccountsResponseModel getGetAccounts()
|
|
530
292
|
|
|
@@ -598,636 +360,22 @@ Get user\'s client credentials
|
|
|
598
360
|
```typescript
|
|
599
361
|
import {
|
|
600
362
|
AccountsApi,
|
|
601
|
-
Configuration
|
|
602
|
-
} from 'yellowgrid-api-ts';
|
|
603
|
-
|
|
604
|
-
const configuration = new Configuration();
|
|
605
|
-
const apiInstance = new AccountsApi(configuration);
|
|
606
|
-
|
|
607
|
-
const { status, data } = await apiInstance.getGetClientCredentials();
|
|
608
|
-
```
|
|
609
|
-
|
|
610
|
-
### Parameters
|
|
611
|
-
This endpoint does not have any parameters.
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
### Return type
|
|
615
|
-
|
|
616
|
-
**Array<ClientModel>**
|
|
617
|
-
|
|
618
|
-
### Authorization
|
|
619
|
-
|
|
620
|
-
No authorization required
|
|
621
|
-
|
|
622
|
-
### HTTP request headers
|
|
623
|
-
|
|
624
|
-
- **Content-Type**: Not defined
|
|
625
|
-
- **Accept**: application/json
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
### HTTP response details
|
|
629
|
-
| Status code | Description | Response headers |
|
|
630
|
-
|-------------|-------------|------------------|
|
|
631
|
-
|**200** | List of client credentials | - |
|
|
632
|
-
|**400** | Bad Request | - |
|
|
633
|
-
|**401** | Unauthorised | - |
|
|
634
|
-
|**403** | Access Denied | - |
|
|
635
|
-
|
|
636
|
-
[[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)
|
|
637
|
-
|
|
638
|
-
# **getGetCustomerKeys**
|
|
639
|
-
> Array<TcxKeySummaryDTO> getGetCustomerKeys()
|
|
640
|
-
|
|
641
|
-
Get 3CX Keys
|
|
642
|
-
|
|
643
|
-
### Example
|
|
644
|
-
|
|
645
|
-
```typescript
|
|
646
|
-
import {
|
|
647
|
-
AccountsApi,
|
|
648
|
-
Configuration
|
|
649
|
-
} from 'yellowgrid-api-ts';
|
|
650
|
-
|
|
651
|
-
const configuration = new Configuration();
|
|
652
|
-
const apiInstance = new AccountsApi(configuration);
|
|
653
|
-
|
|
654
|
-
const { status, data } = await apiInstance.getGetCustomerKeys();
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
### Parameters
|
|
658
|
-
This endpoint does not have any parameters.
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
### Return type
|
|
662
|
-
|
|
663
|
-
**Array<TcxKeySummaryDTO>**
|
|
664
|
-
|
|
665
|
-
### Authorization
|
|
666
|
-
|
|
667
|
-
No authorization required
|
|
668
|
-
|
|
669
|
-
### HTTP request headers
|
|
670
|
-
|
|
671
|
-
- **Content-Type**: Not defined
|
|
672
|
-
- **Accept**: application/json
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
### HTTP response details
|
|
676
|
-
| Status code | Description | Response headers |
|
|
677
|
-
|-------------|-------------|------------------|
|
|
678
|
-
|**200** | 3CX Key Summaries | - |
|
|
679
|
-
|**400** | Bad Request | - |
|
|
680
|
-
|**401** | Unauthorised | - |
|
|
681
|
-
|**403** | Access Denied | - |
|
|
682
|
-
|
|
683
|
-
[[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)
|
|
684
|
-
|
|
685
|
-
# **getGetFinanceSettings**
|
|
686
|
-
> AccountFinanceDTO getGetFinanceSettings()
|
|
687
|
-
|
|
688
|
-
Get Account Finance
|
|
689
|
-
|
|
690
|
-
### Example
|
|
691
|
-
|
|
692
|
-
```typescript
|
|
693
|
-
import {
|
|
694
|
-
AccountsApi,
|
|
695
|
-
Configuration
|
|
696
|
-
} from 'yellowgrid-api-ts';
|
|
697
|
-
|
|
698
|
-
const configuration = new Configuration();
|
|
699
|
-
const apiInstance = new AccountsApi(configuration);
|
|
700
|
-
|
|
701
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
702
|
-
|
|
703
|
-
const { status, data } = await apiInstance.getGetFinanceSettings(
|
|
704
|
-
id
|
|
705
|
-
);
|
|
706
|
-
```
|
|
707
|
-
|
|
708
|
-
### Parameters
|
|
709
|
-
|
|
710
|
-
|Name | Type | Description | Notes|
|
|
711
|
-
|------------- | ------------- | ------------- | -------------|
|
|
712
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
### Return type
|
|
716
|
-
|
|
717
|
-
**AccountFinanceDTO**
|
|
718
|
-
|
|
719
|
-
### Authorization
|
|
720
|
-
|
|
721
|
-
No authorization required
|
|
722
|
-
|
|
723
|
-
### HTTP request headers
|
|
724
|
-
|
|
725
|
-
- **Content-Type**: Not defined
|
|
726
|
-
- **Accept**: application/json
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
### HTTP response details
|
|
730
|
-
| Status code | Description | Response headers |
|
|
731
|
-
|-------------|-------------|------------------|
|
|
732
|
-
|**200** | Accounts Finance Details | - |
|
|
733
|
-
|**400** | Bad Request | - |
|
|
734
|
-
|**401** | Unauthorised | - |
|
|
735
|
-
|**403** | Access Denied | - |
|
|
736
|
-
|
|
737
|
-
[[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)
|
|
738
|
-
|
|
739
|
-
# **getVerifyEmailAddress**
|
|
740
|
-
> getVerifyEmailAddress()
|
|
741
|
-
|
|
742
|
-
Verify account email address
|
|
743
|
-
|
|
744
|
-
### Example
|
|
745
|
-
|
|
746
|
-
```typescript
|
|
747
|
-
import {
|
|
748
|
-
AccountsApi,
|
|
749
|
-
Configuration
|
|
750
|
-
} from 'yellowgrid-api-ts';
|
|
751
|
-
|
|
752
|
-
const configuration = new Configuration();
|
|
753
|
-
const apiInstance = new AccountsApi(configuration);
|
|
754
|
-
|
|
755
|
-
let token: string; //Verification Token (default to undefined)
|
|
756
|
-
|
|
757
|
-
const { status, data } = await apiInstance.getVerifyEmailAddress(
|
|
758
|
-
token
|
|
759
|
-
);
|
|
760
|
-
```
|
|
761
|
-
|
|
762
|
-
### Parameters
|
|
763
|
-
|
|
764
|
-
|Name | Type | Description | Notes|
|
|
765
|
-
|------------- | ------------- | ------------- | -------------|
|
|
766
|
-
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
### Return type
|
|
770
|
-
|
|
771
|
-
void (empty response body)
|
|
772
|
-
|
|
773
|
-
### Authorization
|
|
774
|
-
|
|
775
|
-
No authorization required
|
|
776
|
-
|
|
777
|
-
### HTTP request headers
|
|
778
|
-
|
|
779
|
-
- **Content-Type**: Not defined
|
|
780
|
-
- **Accept**: Not defined
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
### HTTP response details
|
|
784
|
-
| Status code | Description | Response headers |
|
|
785
|
-
|-------------|-------------|------------------|
|
|
786
|
-
|**200** | No Response | - |
|
|
787
|
-
|**400** | Bad Request | - |
|
|
788
|
-
|**401** | Unauthorised | - |
|
|
789
|
-
|**403** | Access Denied | - |
|
|
790
|
-
|
|
791
|
-
[[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)
|
|
792
|
-
|
|
793
|
-
# **patchSetPortalAccess**
|
|
794
|
-
> patchSetPortalAccess()
|
|
795
|
-
|
|
796
|
-
Set Account Portal Access
|
|
797
|
-
|
|
798
|
-
### Example
|
|
799
|
-
|
|
800
|
-
```typescript
|
|
801
|
-
import {
|
|
802
|
-
AccountsApi,
|
|
803
|
-
Configuration
|
|
804
|
-
} from 'yellowgrid-api-ts';
|
|
805
|
-
|
|
806
|
-
const configuration = new Configuration();
|
|
807
|
-
const apiInstance = new AccountsApi(configuration);
|
|
808
|
-
|
|
809
|
-
let id: string; //Xero ID (default to undefined)
|
|
810
|
-
let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
|
|
811
|
-
|
|
812
|
-
const { status, data } = await apiInstance.patchSetPortalAccess(
|
|
813
|
-
id,
|
|
814
|
-
state
|
|
815
|
-
);
|
|
816
|
-
```
|
|
817
|
-
|
|
818
|
-
### Parameters
|
|
819
|
-
|
|
820
|
-
|Name | Type | Description | Notes|
|
|
821
|
-
|------------- | ------------- | ------------- | -------------|
|
|
822
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
823
|
-
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | Portal Access State | defaults to undefined|
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
### Return type
|
|
827
|
-
|
|
828
|
-
void (empty response body)
|
|
829
|
-
|
|
830
|
-
### Authorization
|
|
831
|
-
|
|
832
|
-
No authorization required
|
|
833
|
-
|
|
834
|
-
### HTTP request headers
|
|
835
|
-
|
|
836
|
-
- **Content-Type**: Not defined
|
|
837
|
-
- **Accept**: Not defined
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
### HTTP response details
|
|
841
|
-
| Status code | Description | Response headers |
|
|
842
|
-
|-------------|-------------|------------------|
|
|
843
|
-
|**204** | No Response | - |
|
|
844
|
-
|**400** | Bad Request | - |
|
|
845
|
-
|**401** | Unauthorised | - |
|
|
846
|
-
|**403** | Access Denied | - |
|
|
847
|
-
|
|
848
|
-
[[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)
|
|
849
|
-
|
|
850
|
-
# **patchSetPrizePromo**
|
|
851
|
-
> patchSetPrizePromo()
|
|
852
|
-
|
|
853
|
-
Set Account Prize Promo
|
|
854
|
-
|
|
855
|
-
### Example
|
|
856
|
-
|
|
857
|
-
```typescript
|
|
858
|
-
import {
|
|
859
|
-
AccountsApi,
|
|
860
|
-
Configuration
|
|
861
|
-
} from 'yellowgrid-api-ts';
|
|
862
|
-
|
|
863
|
-
const configuration = new Configuration();
|
|
864
|
-
const apiInstance = new AccountsApi(configuration);
|
|
865
|
-
|
|
866
|
-
let id: string; //Xero ID (default to undefined)
|
|
867
|
-
let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
|
|
868
|
-
|
|
869
|
-
const { status, data } = await apiInstance.patchSetPrizePromo(
|
|
870
|
-
id,
|
|
871
|
-
state
|
|
872
|
-
);
|
|
873
|
-
```
|
|
874
|
-
|
|
875
|
-
### Parameters
|
|
876
|
-
|
|
877
|
-
|Name | Type | Description | Notes|
|
|
878
|
-
|------------- | ------------- | ------------- | -------------|
|
|
879
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
880
|
-
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | Prize Promo State | defaults to undefined|
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
### Return type
|
|
884
|
-
|
|
885
|
-
void (empty response body)
|
|
886
|
-
|
|
887
|
-
### Authorization
|
|
888
|
-
|
|
889
|
-
No authorization required
|
|
890
|
-
|
|
891
|
-
### HTTP request headers
|
|
892
|
-
|
|
893
|
-
- **Content-Type**: Not defined
|
|
894
|
-
- **Accept**: Not defined
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
### HTTP response details
|
|
898
|
-
| Status code | Description | Response headers |
|
|
899
|
-
|-------------|-------------|------------------|
|
|
900
|
-
|**204** | No Response | - |
|
|
901
|
-
|**400** | Bad Request | - |
|
|
902
|
-
|**401** | Unauthorised | - |
|
|
903
|
-
|**403** | Access Denied | - |
|
|
904
|
-
|
|
905
|
-
[[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)
|
|
906
|
-
|
|
907
|
-
# **patchSetTcxWizardCname**
|
|
908
|
-
> patchSetTcxWizardCname()
|
|
909
|
-
|
|
910
|
-
Set 3CX Wizard CNAME
|
|
911
|
-
|
|
912
|
-
### Example
|
|
913
|
-
|
|
914
|
-
```typescript
|
|
915
|
-
import {
|
|
916
|
-
AccountsApi,
|
|
917
|
-
Configuration,
|
|
918
|
-
PatchUpdateAccountCnameRequest
|
|
919
|
-
} from 'yellowgrid-api-ts';
|
|
920
|
-
|
|
921
|
-
const configuration = new Configuration();
|
|
922
|
-
const apiInstance = new AccountsApi(configuration);
|
|
923
|
-
|
|
924
|
-
let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
|
|
925
|
-
|
|
926
|
-
const { status, data } = await apiInstance.patchSetTcxWizardCname(
|
|
927
|
-
patchUpdateAccountCnameRequest
|
|
928
|
-
);
|
|
929
|
-
```
|
|
930
|
-
|
|
931
|
-
### Parameters
|
|
932
|
-
|
|
933
|
-
|Name | Type | Description | Notes|
|
|
934
|
-
|------------- | ------------- | ------------- | -------------|
|
|
935
|
-
| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
### Return type
|
|
939
|
-
|
|
940
|
-
void (empty response body)
|
|
941
|
-
|
|
942
|
-
### Authorization
|
|
943
|
-
|
|
944
|
-
No authorization required
|
|
945
|
-
|
|
946
|
-
### HTTP request headers
|
|
947
|
-
|
|
948
|
-
- **Content-Type**: application/json
|
|
949
|
-
- **Accept**: Not defined
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
### HTTP response details
|
|
953
|
-
| Status code | Description | Response headers |
|
|
954
|
-
|-------------|-------------|------------------|
|
|
955
|
-
|**200** | No Response | - |
|
|
956
|
-
|**400** | Bad Request | - |
|
|
957
|
-
|**401** | Unauthorised | - |
|
|
958
|
-
|**403** | Access Denied | - |
|
|
959
|
-
|
|
960
|
-
[[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)
|
|
961
|
-
|
|
962
|
-
# **patchUpdateAccountCname**
|
|
963
|
-
> patchUpdateAccountCname()
|
|
964
|
-
|
|
965
|
-
Set Account CNAME
|
|
966
|
-
|
|
967
|
-
### Example
|
|
968
|
-
|
|
969
|
-
```typescript
|
|
970
|
-
import {
|
|
971
|
-
AccountsApi,
|
|
972
|
-
Configuration,
|
|
973
|
-
PatchUpdateAccountCnameRequest
|
|
974
|
-
} from 'yellowgrid-api-ts';
|
|
975
|
-
|
|
976
|
-
const configuration = new Configuration();
|
|
977
|
-
const apiInstance = new AccountsApi(configuration);
|
|
978
|
-
|
|
979
|
-
let id: string; //Xero ID (default to undefined)
|
|
980
|
-
let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
|
|
981
|
-
|
|
982
|
-
const { status, data } = await apiInstance.patchUpdateAccountCname(
|
|
983
|
-
id,
|
|
984
|
-
patchUpdateAccountCnameRequest
|
|
985
|
-
);
|
|
986
|
-
```
|
|
987
|
-
|
|
988
|
-
### Parameters
|
|
989
|
-
|
|
990
|
-
|Name | Type | Description | Notes|
|
|
991
|
-
|------------- | ------------- | ------------- | -------------|
|
|
992
|
-
| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
|
|
993
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
### Return type
|
|
997
|
-
|
|
998
|
-
void (empty response body)
|
|
999
|
-
|
|
1000
|
-
### Authorization
|
|
1001
|
-
|
|
1002
|
-
No authorization required
|
|
1003
|
-
|
|
1004
|
-
### HTTP request headers
|
|
1005
|
-
|
|
1006
|
-
- **Content-Type**: application/json
|
|
1007
|
-
- **Accept**: Not defined
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
### HTTP response details
|
|
1011
|
-
| Status code | Description | Response headers |
|
|
1012
|
-
|-------------|-------------|------------------|
|
|
1013
|
-
|**204** | No Response | - |
|
|
1014
|
-
|**400** | Bad Request | - |
|
|
1015
|
-
|**401** | Unauthorised | - |
|
|
1016
|
-
|**403** | Access Denied | - |
|
|
1017
|
-
|
|
1018
|
-
[[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)
|
|
1019
|
-
|
|
1020
|
-
# **patchUpdateAccountCompanyNumber**
|
|
1021
|
-
> patchUpdateAccountCompanyNumber()
|
|
1022
|
-
|
|
1023
|
-
Set Account Company Number
|
|
1024
|
-
|
|
1025
|
-
### Example
|
|
1026
|
-
|
|
1027
|
-
```typescript
|
|
1028
|
-
import {
|
|
1029
|
-
AccountsApi,
|
|
1030
|
-
Configuration,
|
|
1031
|
-
PatchUpdateAccountCompanyNumberRequest
|
|
1032
|
-
} from 'yellowgrid-api-ts';
|
|
1033
|
-
|
|
1034
|
-
const configuration = new Configuration();
|
|
1035
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1036
|
-
|
|
1037
|
-
let id: string; //Xero ID (default to undefined)
|
|
1038
|
-
let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
|
|
1039
|
-
|
|
1040
|
-
const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
|
|
1041
|
-
id,
|
|
1042
|
-
patchUpdateAccountCompanyNumberRequest
|
|
1043
|
-
);
|
|
1044
|
-
```
|
|
1045
|
-
|
|
1046
|
-
### Parameters
|
|
1047
|
-
|
|
1048
|
-
|Name | Type | Description | Notes|
|
|
1049
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1050
|
-
| **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
|
|
1051
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
### Return type
|
|
1055
|
-
|
|
1056
|
-
void (empty response body)
|
|
1057
|
-
|
|
1058
|
-
### Authorization
|
|
1059
|
-
|
|
1060
|
-
No authorization required
|
|
1061
|
-
|
|
1062
|
-
### HTTP request headers
|
|
1063
|
-
|
|
1064
|
-
- **Content-Type**: application/json
|
|
1065
|
-
- **Accept**: Not defined
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
### HTTP response details
|
|
1069
|
-
| Status code | Description | Response headers |
|
|
1070
|
-
|-------------|-------------|------------------|
|
|
1071
|
-
|**204** | No Response | - |
|
|
1072
|
-
|**400** | Bad Request | - |
|
|
1073
|
-
|**401** | Unauthorised | - |
|
|
1074
|
-
|**403** | Access Denied | - |
|
|
1075
|
-
|
|
1076
|
-
[[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)
|
|
1077
|
-
|
|
1078
|
-
# **patchUpdateAccountContactPassword**
|
|
1079
|
-
> patchUpdateAccountContactPassword()
|
|
1080
|
-
|
|
1081
|
-
Update Account Password
|
|
1082
|
-
|
|
1083
|
-
### Example
|
|
1084
|
-
|
|
1085
|
-
```typescript
|
|
1086
|
-
import {
|
|
1087
|
-
AccountsApi,
|
|
1088
|
-
Configuration,
|
|
1089
|
-
PatchUpdateAccountContactPasswordRequest
|
|
1090
|
-
} from 'yellowgrid-api-ts';
|
|
1091
|
-
|
|
1092
|
-
const configuration = new Configuration();
|
|
1093
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1094
|
-
|
|
1095
|
-
let token: string; //Verification Token (default to undefined)
|
|
1096
|
-
let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
|
|
1097
|
-
|
|
1098
|
-
const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
|
|
1099
|
-
token,
|
|
1100
|
-
patchUpdateAccountContactPasswordRequest
|
|
1101
|
-
);
|
|
1102
|
-
```
|
|
1103
|
-
|
|
1104
|
-
### Parameters
|
|
1105
|
-
|
|
1106
|
-
|Name | Type | Description | Notes|
|
|
1107
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1108
|
-
| **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
|
|
1109
|
-
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
### Return type
|
|
1113
|
-
|
|
1114
|
-
void (empty response body)
|
|
1115
|
-
|
|
1116
|
-
### Authorization
|
|
1117
|
-
|
|
1118
|
-
No authorization required
|
|
1119
|
-
|
|
1120
|
-
### HTTP request headers
|
|
1121
|
-
|
|
1122
|
-
- **Content-Type**: application/json
|
|
1123
|
-
- **Accept**: Not defined
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
### HTTP response details
|
|
1127
|
-
| Status code | Description | Response headers |
|
|
1128
|
-
|-------------|-------------|------------------|
|
|
1129
|
-
|**200** | No Response | - |
|
|
1130
|
-
|**400** | Bad Request | - |
|
|
1131
|
-
|**401** | Unauthorised | - |
|
|
1132
|
-
|**403** | Access Denied | - |
|
|
1133
|
-
|
|
1134
|
-
[[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)
|
|
1135
|
-
|
|
1136
|
-
# **patchUpdateAccountPhone**
|
|
1137
|
-
> patchUpdateAccountPhone()
|
|
1138
|
-
|
|
1139
|
-
Set Account Phone
|
|
1140
|
-
|
|
1141
|
-
### Example
|
|
1142
|
-
|
|
1143
|
-
```typescript
|
|
1144
|
-
import {
|
|
1145
|
-
AccountsApi,
|
|
1146
|
-
Configuration,
|
|
1147
|
-
PatchUpdateAccountPhoneRequest
|
|
1148
|
-
} from 'yellowgrid-api-ts';
|
|
1149
|
-
|
|
1150
|
-
const configuration = new Configuration();
|
|
1151
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1152
|
-
|
|
1153
|
-
let id: string; //Xero ID (default to undefined)
|
|
1154
|
-
let patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
|
|
1155
|
-
|
|
1156
|
-
const { status, data } = await apiInstance.patchUpdateAccountPhone(
|
|
1157
|
-
id,
|
|
1158
|
-
patchUpdateAccountPhoneRequest
|
|
1159
|
-
);
|
|
1160
|
-
```
|
|
1161
|
-
|
|
1162
|
-
### Parameters
|
|
1163
|
-
|
|
1164
|
-
|Name | Type | Description | Notes|
|
|
1165
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1166
|
-
| **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone Request | |
|
|
1167
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
### Return type
|
|
1171
|
-
|
|
1172
|
-
void (empty response body)
|
|
1173
|
-
|
|
1174
|
-
### Authorization
|
|
1175
|
-
|
|
1176
|
-
No authorization required
|
|
1177
|
-
|
|
1178
|
-
### HTTP request headers
|
|
1179
|
-
|
|
1180
|
-
- **Content-Type**: application/json
|
|
1181
|
-
- **Accept**: Not defined
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
### HTTP response details
|
|
1185
|
-
| Status code | Description | Response headers |
|
|
1186
|
-
|-------------|-------------|------------------|
|
|
1187
|
-
|**204** | No Response | - |
|
|
1188
|
-
|**400** | Bad Request | - |
|
|
1189
|
-
|**401** | Unauthorised | - |
|
|
1190
|
-
|**403** | Access Denied | - |
|
|
1191
|
-
|
|
1192
|
-
[[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)
|
|
1193
|
-
|
|
1194
|
-
# **patchUpdateAccountVatNumber**
|
|
1195
|
-
> patchUpdateAccountVatNumber()
|
|
1196
|
-
|
|
1197
|
-
Set Account VAT Number
|
|
1198
|
-
|
|
1199
|
-
### Example
|
|
1200
|
-
|
|
1201
|
-
```typescript
|
|
1202
|
-
import {
|
|
1203
|
-
AccountsApi,
|
|
1204
|
-
Configuration,
|
|
1205
|
-
PatchUpdateAccountVatNumberRequest
|
|
363
|
+
Configuration
|
|
1206
364
|
} from 'yellowgrid-api-ts';
|
|
1207
365
|
|
|
1208
366
|
const configuration = new Configuration();
|
|
1209
367
|
const apiInstance = new AccountsApi(configuration);
|
|
1210
368
|
|
|
1211
|
-
|
|
1212
|
-
let patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
|
|
1213
|
-
|
|
1214
|
-
const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
|
|
1215
|
-
id,
|
|
1216
|
-
patchUpdateAccountVatNumberRequest
|
|
1217
|
-
);
|
|
369
|
+
const { status, data } = await apiInstance.getGetClientCredentials();
|
|
1218
370
|
```
|
|
1219
371
|
|
|
1220
372
|
### Parameters
|
|
1221
|
-
|
|
1222
|
-
|Name | Type | Description | Notes|
|
|
1223
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1224
|
-
| **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
|
|
1225
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
373
|
+
This endpoint does not have any parameters.
|
|
1226
374
|
|
|
1227
375
|
|
|
1228
376
|
### Return type
|
|
1229
377
|
|
|
1230
|
-
|
|
378
|
+
**Array<ClientModel>**
|
|
1231
379
|
|
|
1232
380
|
### Authorization
|
|
1233
381
|
|
|
@@ -1235,57 +383,46 @@ No authorization required
|
|
|
1235
383
|
|
|
1236
384
|
### HTTP request headers
|
|
1237
385
|
|
|
1238
|
-
- **Content-Type**:
|
|
1239
|
-
- **Accept**:
|
|
386
|
+
- **Content-Type**: Not defined
|
|
387
|
+
- **Accept**: application/json
|
|
1240
388
|
|
|
1241
389
|
|
|
1242
390
|
### HTTP response details
|
|
1243
391
|
| Status code | Description | Response headers |
|
|
1244
392
|
|-------------|-------------|------------------|
|
|
1245
|
-
|**
|
|
393
|
+
|**200** | List of client credentials | - |
|
|
1246
394
|
|**400** | Bad Request | - |
|
|
1247
395
|
|**401** | Unauthorised | - |
|
|
1248
396
|
|**403** | Access Denied | - |
|
|
1249
397
|
|
|
1250
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)
|
|
1251
399
|
|
|
1252
|
-
# **
|
|
1253
|
-
>
|
|
400
|
+
# **getGetCustomerKeys**
|
|
401
|
+
> Array<TcxKeySummaryDTO> getGetCustomerKeys()
|
|
1254
402
|
|
|
1255
|
-
|
|
403
|
+
Get 3CX Keys
|
|
1256
404
|
|
|
1257
405
|
### Example
|
|
1258
406
|
|
|
1259
407
|
```typescript
|
|
1260
408
|
import {
|
|
1261
409
|
AccountsApi,
|
|
1262
|
-
Configuration
|
|
1263
|
-
PatchUpdateCreditLimitRequest
|
|
410
|
+
Configuration
|
|
1264
411
|
} from 'yellowgrid-api-ts';
|
|
1265
412
|
|
|
1266
413
|
const configuration = new Configuration();
|
|
1267
414
|
const apiInstance = new AccountsApi(configuration);
|
|
1268
415
|
|
|
1269
|
-
|
|
1270
|
-
let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
|
|
1271
|
-
|
|
1272
|
-
const { status, data } = await apiInstance.patchUpdateCreditLimit(
|
|
1273
|
-
id,
|
|
1274
|
-
patchUpdateCreditLimitRequest
|
|
1275
|
-
);
|
|
416
|
+
const { status, data } = await apiInstance.getGetCustomerKeys();
|
|
1276
417
|
```
|
|
1277
418
|
|
|
1278
419
|
### Parameters
|
|
1279
|
-
|
|
1280
|
-
|Name | Type | Description | Notes|
|
|
1281
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1282
|
-
| **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
|
|
1283
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
420
|
+
This endpoint does not have any parameters.
|
|
1284
421
|
|
|
1285
422
|
|
|
1286
423
|
### Return type
|
|
1287
424
|
|
|
1288
|
-
**
|
|
425
|
+
**Array<TcxKeySummaryDTO>**
|
|
1289
426
|
|
|
1290
427
|
### Authorization
|
|
1291
428
|
|
|
@@ -1293,43 +430,40 @@ No authorization required
|
|
|
1293
430
|
|
|
1294
431
|
### HTTP request headers
|
|
1295
432
|
|
|
1296
|
-
- **Content-Type**:
|
|
433
|
+
- **Content-Type**: Not defined
|
|
1297
434
|
- **Accept**: application/json
|
|
1298
435
|
|
|
1299
436
|
|
|
1300
437
|
### HTTP response details
|
|
1301
438
|
| Status code | Description | Response headers |
|
|
1302
439
|
|-------------|-------------|------------------|
|
|
1303
|
-
|**200** |
|
|
440
|
+
|**200** | 3CX Key Summaries | - |
|
|
1304
441
|
|**400** | Bad Request | - |
|
|
1305
442
|
|**401** | Unauthorised | - |
|
|
1306
443
|
|**403** | Access Denied | - |
|
|
1307
444
|
|
|
1308
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)
|
|
1309
446
|
|
|
1310
|
-
# **
|
|
1311
|
-
>
|
|
447
|
+
# **getVerifyEmailAddress**
|
|
448
|
+
> getVerifyEmailAddress()
|
|
1312
449
|
|
|
1313
|
-
|
|
450
|
+
Verify account email address
|
|
1314
451
|
|
|
1315
452
|
### Example
|
|
1316
453
|
|
|
1317
454
|
```typescript
|
|
1318
455
|
import {
|
|
1319
456
|
AccountsApi,
|
|
1320
|
-
Configuration
|
|
1321
|
-
PatchUpdatePriceListRequest
|
|
457
|
+
Configuration
|
|
1322
458
|
} from 'yellowgrid-api-ts';
|
|
1323
459
|
|
|
1324
460
|
const configuration = new Configuration();
|
|
1325
461
|
const apiInstance = new AccountsApi(configuration);
|
|
1326
462
|
|
|
1327
|
-
let
|
|
1328
|
-
let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
|
|
463
|
+
let token: string; //Verification Token (default to undefined)
|
|
1329
464
|
|
|
1330
|
-
const { status, data } = await apiInstance.
|
|
1331
|
-
|
|
1332
|
-
patchUpdatePriceListRequest
|
|
465
|
+
const { status, data } = await apiInstance.getVerifyEmailAddress(
|
|
466
|
+
token
|
|
1333
467
|
);
|
|
1334
468
|
```
|
|
1335
469
|
|
|
@@ -1337,13 +471,12 @@ const { status, data } = await apiInstance.patchUpdatePriceList(
|
|
|
1337
471
|
|
|
1338
472
|
|Name | Type | Description | Notes|
|
|
1339
473
|
|------------- | ------------- | ------------- | -------------|
|
|
1340
|
-
| **
|
|
1341
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
474
|
+
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1342
475
|
|
|
1343
476
|
|
|
1344
477
|
### Return type
|
|
1345
478
|
|
|
1346
|
-
|
|
479
|
+
void (empty response body)
|
|
1347
480
|
|
|
1348
481
|
### Authorization
|
|
1349
482
|
|
|
@@ -1351,24 +484,24 @@ No authorization required
|
|
|
1351
484
|
|
|
1352
485
|
### HTTP request headers
|
|
1353
486
|
|
|
1354
|
-
- **Content-Type**:
|
|
1355
|
-
- **Accept**:
|
|
487
|
+
- **Content-Type**: Not defined
|
|
488
|
+
- **Accept**: Not defined
|
|
1356
489
|
|
|
1357
490
|
|
|
1358
491
|
### HTTP response details
|
|
1359
492
|
| Status code | Description | Response headers |
|
|
1360
493
|
|-------------|-------------|------------------|
|
|
1361
|
-
|**200** |
|
|
494
|
+
|**200** | No Response | - |
|
|
1362
495
|
|**400** | Bad Request | - |
|
|
1363
496
|
|**401** | Unauthorised | - |
|
|
1364
497
|
|**403** | Access Denied | - |
|
|
1365
498
|
|
|
1366
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)
|
|
1367
500
|
|
|
1368
|
-
# **
|
|
1369
|
-
>
|
|
501
|
+
# **patchSetTcxWizardCname**
|
|
502
|
+
> patchSetTcxWizardCname()
|
|
1370
503
|
|
|
1371
|
-
Set
|
|
504
|
+
Set 3CX Wizard CNAME
|
|
1372
505
|
|
|
1373
506
|
### Example
|
|
1374
507
|
|
|
@@ -1376,18 +509,16 @@ Set Account SIP Channel Cost
|
|
|
1376
509
|
import {
|
|
1377
510
|
AccountsApi,
|
|
1378
511
|
Configuration,
|
|
1379
|
-
|
|
512
|
+
PatchSetTcxWizardCnameRequest
|
|
1380
513
|
} from 'yellowgrid-api-ts';
|
|
1381
514
|
|
|
1382
515
|
const configuration = new Configuration();
|
|
1383
516
|
const apiInstance = new AccountsApi(configuration);
|
|
1384
517
|
|
|
1385
|
-
let
|
|
1386
|
-
let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
|
|
518
|
+
let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
|
|
1387
519
|
|
|
1388
|
-
const { status, data } = await apiInstance.
|
|
1389
|
-
|
|
1390
|
-
patchUpdateSipChannelCostRequest
|
|
520
|
+
const { status, data } = await apiInstance.patchSetTcxWizardCname(
|
|
521
|
+
patchSetTcxWizardCnameRequest
|
|
1391
522
|
);
|
|
1392
523
|
```
|
|
1393
524
|
|
|
@@ -1395,13 +526,12 @@ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
|
|
|
1395
526
|
|
|
1396
527
|
|Name | Type | Description | Notes|
|
|
1397
528
|
|------------- | ------------- | ------------- | -------------|
|
|
1398
|
-
| **
|
|
1399
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
529
|
+
| **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
|
|
1400
530
|
|
|
1401
531
|
|
|
1402
532
|
### Return type
|
|
1403
533
|
|
|
1404
|
-
|
|
534
|
+
void (empty response body)
|
|
1405
535
|
|
|
1406
536
|
### Authorization
|
|
1407
537
|
|
|
@@ -1410,23 +540,23 @@ No authorization required
|
|
|
1410
540
|
### HTTP request headers
|
|
1411
541
|
|
|
1412
542
|
- **Content-Type**: application/json
|
|
1413
|
-
- **Accept**:
|
|
543
|
+
- **Accept**: Not defined
|
|
1414
544
|
|
|
1415
545
|
|
|
1416
546
|
### HTTP response details
|
|
1417
547
|
| Status code | Description | Response headers |
|
|
1418
548
|
|-------------|-------------|------------------|
|
|
1419
|
-
|**200** |
|
|
549
|
+
|**200** | No Response | - |
|
|
1420
550
|
|**400** | Bad Request | - |
|
|
1421
551
|
|**401** | Unauthorised | - |
|
|
1422
552
|
|**403** | Access Denied | - |
|
|
1423
553
|
|
|
1424
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)
|
|
1425
555
|
|
|
1426
|
-
# **
|
|
1427
|
-
>
|
|
556
|
+
# **patchUpdateAccountContactPassword**
|
|
557
|
+
> patchUpdateAccountContactPassword()
|
|
1428
558
|
|
|
1429
|
-
|
|
559
|
+
Update Account Password
|
|
1430
560
|
|
|
1431
561
|
### Example
|
|
1432
562
|
|
|
@@ -1434,18 +564,18 @@ Create Account Contact
|
|
|
1434
564
|
import {
|
|
1435
565
|
AccountsApi,
|
|
1436
566
|
Configuration,
|
|
1437
|
-
|
|
567
|
+
PatchUpdateAccountContactPasswordRequest
|
|
1438
568
|
} from 'yellowgrid-api-ts';
|
|
1439
569
|
|
|
1440
570
|
const configuration = new Configuration();
|
|
1441
571
|
const apiInstance = new AccountsApi(configuration);
|
|
1442
572
|
|
|
1443
|
-
let
|
|
1444
|
-
let
|
|
573
|
+
let token: string; //Verification Token (default to undefined)
|
|
574
|
+
let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
|
|
1445
575
|
|
|
1446
|
-
const { status, data } = await apiInstance.
|
|
1447
|
-
|
|
1448
|
-
|
|
576
|
+
const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
|
|
577
|
+
token,
|
|
578
|
+
patchUpdateAccountContactPasswordRequest
|
|
1449
579
|
);
|
|
1450
580
|
```
|
|
1451
581
|
|
|
@@ -1453,8 +583,8 @@ const { status, data } = await apiInstance.postAdminCreateAccountContact(
|
|
|
1453
583
|
|
|
1454
584
|
|Name | Type | Description | Notes|
|
|
1455
585
|
|------------- | ------------- | ------------- | -------------|
|
|
1456
|
-
| **
|
|
1457
|
-
| **
|
|
586
|
+
| **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
|
|
587
|
+
| **token** | [**string**] | Verification Token | defaults to undefined|
|
|
1458
588
|
|
|
1459
589
|
|
|
1460
590
|
### Return type
|
|
@@ -1474,7 +604,7 @@ No authorization required
|
|
|
1474
604
|
### HTTP response details
|
|
1475
605
|
| Status code | Description | Response headers |
|
|
1476
606
|
|-------------|-------------|------------------|
|
|
1477
|
-
|**
|
|
607
|
+
|**200** | No Response | - |
|
|
1478
608
|
|**400** | Bad Request | - |
|
|
1479
609
|
|**401** | Unauthorised | - |
|
|
1480
610
|
|**403** | Access Denied | - |
|
|
@@ -1791,64 +921,6 @@ No authorization required
|
|
|
1791
921
|
- **Accept**: Not defined
|
|
1792
922
|
|
|
1793
923
|
|
|
1794
|
-
### HTTP response details
|
|
1795
|
-
| Status code | Description | Response headers |
|
|
1796
|
-
|-------------|-------------|------------------|
|
|
1797
|
-
|**200** | No Response | - |
|
|
1798
|
-
|**400** | Bad Request | - |
|
|
1799
|
-
|**401** | Unauthorised | - |
|
|
1800
|
-
|**403** | Access Denied | - |
|
|
1801
|
-
|
|
1802
|
-
[[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)
|
|
1803
|
-
|
|
1804
|
-
# **postSendWelcomeEmail**
|
|
1805
|
-
> postSendWelcomeEmail()
|
|
1806
|
-
|
|
1807
|
-
Send Account Welcome Email
|
|
1808
|
-
|
|
1809
|
-
### Example
|
|
1810
|
-
|
|
1811
|
-
```typescript
|
|
1812
|
-
import {
|
|
1813
|
-
AccountsApi,
|
|
1814
|
-
Configuration,
|
|
1815
|
-
PostSendWelcomeEmailRequest
|
|
1816
|
-
} from 'yellowgrid-api-ts';
|
|
1817
|
-
|
|
1818
|
-
const configuration = new Configuration();
|
|
1819
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1820
|
-
|
|
1821
|
-
let id: string; //Xero ID (default to undefined)
|
|
1822
|
-
let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
|
|
1823
|
-
|
|
1824
|
-
const { status, data } = await apiInstance.postSendWelcomeEmail(
|
|
1825
|
-
id,
|
|
1826
|
-
postSendWelcomeEmailRequest
|
|
1827
|
-
);
|
|
1828
|
-
```
|
|
1829
|
-
|
|
1830
|
-
### Parameters
|
|
1831
|
-
|
|
1832
|
-
|Name | Type | Description | Notes|
|
|
1833
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1834
|
-
| **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
|
|
1835
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
### Return type
|
|
1839
|
-
|
|
1840
|
-
void (empty response body)
|
|
1841
|
-
|
|
1842
|
-
### Authorization
|
|
1843
|
-
|
|
1844
|
-
No authorization required
|
|
1845
|
-
|
|
1846
|
-
### HTTP request headers
|
|
1847
|
-
|
|
1848
|
-
- **Content-Type**: application/json
|
|
1849
|
-
- **Accept**: Not defined
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
924
|
### HTTP response details
|
|
1853
925
|
| Status code | Description | Response headers |
|
|
1854
926
|
|-------------|-------------|------------------|
|
|
@@ -1919,67 +991,6 @@ No authorization required
|
|
|
1919
991
|
|
|
1920
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)
|
|
1921
993
|
|
|
1922
|
-
# **putAdminUpdateAccountContact**
|
|
1923
|
-
> putAdminUpdateAccountContact()
|
|
1924
|
-
|
|
1925
|
-
Update Account Contact
|
|
1926
|
-
|
|
1927
|
-
### Example
|
|
1928
|
-
|
|
1929
|
-
```typescript
|
|
1930
|
-
import {
|
|
1931
|
-
AccountsApi,
|
|
1932
|
-
Configuration,
|
|
1933
|
-
AccountContactRequestModel
|
|
1934
|
-
} from 'yellowgrid-api-ts';
|
|
1935
|
-
|
|
1936
|
-
const configuration = new Configuration();
|
|
1937
|
-
const apiInstance = new AccountsApi(configuration);
|
|
1938
|
-
|
|
1939
|
-
let id: string; //Account Xero ID (default to undefined)
|
|
1940
|
-
let contactId: number; //Contact ID (default to undefined)
|
|
1941
|
-
let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
|
|
1942
|
-
|
|
1943
|
-
const { status, data } = await apiInstance.putAdminUpdateAccountContact(
|
|
1944
|
-
id,
|
|
1945
|
-
contactId,
|
|
1946
|
-
accountContactRequestModel
|
|
1947
|
-
);
|
|
1948
|
-
```
|
|
1949
|
-
|
|
1950
|
-
### Parameters
|
|
1951
|
-
|
|
1952
|
-
|Name | Type | Description | Notes|
|
|
1953
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1954
|
-
| **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
|
|
1955
|
-
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
1956
|
-
| **contactId** | [**number**] | Contact ID | defaults to undefined|
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
### Return type
|
|
1960
|
-
|
|
1961
|
-
void (empty response body)
|
|
1962
|
-
|
|
1963
|
-
### Authorization
|
|
1964
|
-
|
|
1965
|
-
No authorization required
|
|
1966
|
-
|
|
1967
|
-
### HTTP request headers
|
|
1968
|
-
|
|
1969
|
-
- **Content-Type**: application/json
|
|
1970
|
-
- **Accept**: Not defined
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
### HTTP response details
|
|
1974
|
-
| Status code | Description | Response headers |
|
|
1975
|
-
|-------------|-------------|------------------|
|
|
1976
|
-
|**204** | No Response | - |
|
|
1977
|
-
|**400** | Bad Request | - |
|
|
1978
|
-
|**401** | Unauthorised | - |
|
|
1979
|
-
|**403** | Access Denied | - |
|
|
1980
|
-
|
|
1981
|
-
[[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)
|
|
1982
|
-
|
|
1983
994
|
# **putUpdateAccountContact**
|
|
1984
995
|
> putUpdateAccountContact()
|
|
1985
996
|
|
|
@@ -2038,119 +1049,3 @@ No authorization required
|
|
|
2038
1049
|
|
|
2039
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)
|
|
2040
1051
|
|
|
2041
|
-
# **putUpdateBillingAddress**
|
|
2042
|
-
> putUpdateBillingAddress()
|
|
2043
|
-
|
|
2044
|
-
Update Account Billing Address
|
|
2045
|
-
|
|
2046
|
-
### Example
|
|
2047
|
-
|
|
2048
|
-
```typescript
|
|
2049
|
-
import {
|
|
2050
|
-
AccountsApi,
|
|
2051
|
-
Configuration,
|
|
2052
|
-
AddressDTO
|
|
2053
|
-
} from 'yellowgrid-api-ts';
|
|
2054
|
-
|
|
2055
|
-
const configuration = new Configuration();
|
|
2056
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2057
|
-
|
|
2058
|
-
let id: string; //Xero ID (default to undefined)
|
|
2059
|
-
let addressDTO: AddressDTO; //Updated Billing Address (optional)
|
|
2060
|
-
|
|
2061
|
-
const { status, data } = await apiInstance.putUpdateBillingAddress(
|
|
2062
|
-
id,
|
|
2063
|
-
addressDTO
|
|
2064
|
-
);
|
|
2065
|
-
```
|
|
2066
|
-
|
|
2067
|
-
### Parameters
|
|
2068
|
-
|
|
2069
|
-
|Name | Type | Description | Notes|
|
|
2070
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2071
|
-
| **addressDTO** | **AddressDTO**| Updated Billing Address | |
|
|
2072
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
### Return type
|
|
2076
|
-
|
|
2077
|
-
void (empty response body)
|
|
2078
|
-
|
|
2079
|
-
### Authorization
|
|
2080
|
-
|
|
2081
|
-
No authorization required
|
|
2082
|
-
|
|
2083
|
-
### HTTP request headers
|
|
2084
|
-
|
|
2085
|
-
- **Content-Type**: application/json
|
|
2086
|
-
- **Accept**: Not defined
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
### HTTP response details
|
|
2090
|
-
| Status code | Description | Response headers |
|
|
2091
|
-
|-------------|-------------|------------------|
|
|
2092
|
-
|**204** | No Response | - |
|
|
2093
|
-
|**400** | Bad Request | - |
|
|
2094
|
-
|**401** | Unauthorised | - |
|
|
2095
|
-
|**403** | Access Denied | - |
|
|
2096
|
-
|
|
2097
|
-
[[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)
|
|
2098
|
-
|
|
2099
|
-
# **putUpdateShippingAddress**
|
|
2100
|
-
> putUpdateShippingAddress()
|
|
2101
|
-
|
|
2102
|
-
Update Account Shipping Address
|
|
2103
|
-
|
|
2104
|
-
### Example
|
|
2105
|
-
|
|
2106
|
-
```typescript
|
|
2107
|
-
import {
|
|
2108
|
-
AccountsApi,
|
|
2109
|
-
Configuration,
|
|
2110
|
-
AddressDTO
|
|
2111
|
-
} from 'yellowgrid-api-ts';
|
|
2112
|
-
|
|
2113
|
-
const configuration = new Configuration();
|
|
2114
|
-
const apiInstance = new AccountsApi(configuration);
|
|
2115
|
-
|
|
2116
|
-
let id: string; //Xero ID (default to undefined)
|
|
2117
|
-
let addressDTO: AddressDTO; //Updated Shipping Address (optional)
|
|
2118
|
-
|
|
2119
|
-
const { status, data } = await apiInstance.putUpdateShippingAddress(
|
|
2120
|
-
id,
|
|
2121
|
-
addressDTO
|
|
2122
|
-
);
|
|
2123
|
-
```
|
|
2124
|
-
|
|
2125
|
-
### Parameters
|
|
2126
|
-
|
|
2127
|
-
|Name | Type | Description | Notes|
|
|
2128
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2129
|
-
| **addressDTO** | **AddressDTO**| Updated Shipping Address | |
|
|
2130
|
-
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
### Return type
|
|
2134
|
-
|
|
2135
|
-
void (empty response body)
|
|
2136
|
-
|
|
2137
|
-
### Authorization
|
|
2138
|
-
|
|
2139
|
-
No authorization required
|
|
2140
|
-
|
|
2141
|
-
### HTTP request headers
|
|
2142
|
-
|
|
2143
|
-
- **Content-Type**: application/json
|
|
2144
|
-
- **Accept**: Not defined
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
### HTTP response details
|
|
2148
|
-
| Status code | Description | Response headers |
|
|
2149
|
-
|-------------|-------------|------------------|
|
|
2150
|
-
|**204** | No Response | - |
|
|
2151
|
-
|**400** | Bad Request | - |
|
|
2152
|
-
|**401** | Unauthorised | - |
|
|
2153
|
-
|**403** | Access Denied | - |
|
|
2154
|
-
|
|
2155
|
-
[[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)
|
|
2156
|
-
|