yellowgrid-api-ts 3.2.211-dev.0 → 3.2.213-dev.0

package/docs/PostAddCallTariffToCallTariffPlanRequest.md

@@ -0,0 +1,34 @@
+# PostAddCallTariffToCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**planName** | **string** |  | [optional] [default to undefined]
+**priceGroupName** | **string** |  | [optional] [default to undefined]
+**tariffRateMarkup** | **string** |  | [optional] [default to undefined]
+**tariffRateDay** | **number** |  | [optional] [default to undefined]
+**tariffRateEvening** | **number** |  | [optional] [default to undefined]
+**tariffRateWeekend** | **number** |  | [optional] [default to undefined]
+**tariffRateMinimum** | **number** |  | [optional] [default to undefined]
+**tariffRateSetup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddCallTariffToCallTariffPlanRequest = {
+    planName,
+    priceGroupName,
+    tariffRateMarkup,
+    tariffRateDay,
+    tariffRateEvening,
+    tariffRateWeekend,
+    tariffRateMinimum,
+    tariffRateSetup,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostAddEthernetRequest.md

@@ -0,0 +1,28 @@
+# PostAddEthernetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** |  | [optional] [default to undefined]
+**cesRef** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddEthernetRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddEthernetRequest = {
+    customerId,
+    cesRef,
+    connectionDate,
+    servicePlanName,
+    invoiceDescription,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostAddRecurringChargeRequest.md

@@ -0,0 +1,30 @@
+# PostAddRecurringChargeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**endPeriod** | **string** | Date Time | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddRecurringChargeRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddRecurringChargeRequest = {
+    reference,
+    description,
+    customerCharge,
+    quantity,
+    endPeriod,
+    accountCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostAddServiceToServicePlanRequest.md

@@ -0,0 +1,30 @@
+# PostAddServiceToServicePlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+**customerRate_Markup** | **string** |  | [optional] [default to undefined]
+**customerRate_Amount** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddServiceToServicePlanRequest = {
+    serviceCode,
+    planGroup,
+    customerRate_Markup,
+    customerRate_Amount,
+    description,
+    hideOnInvoice,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostAddSipTrunkDDIsRequest.md

@@ -0,0 +1,30 @@
+# PostAddSipTrunkDDIsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDDI** | **Array<string>** |  | [optional] [default to undefined]
+**sipTrunkSdrRefId** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**endDDI** | **Array<string>** |  | [optional] [default to undefined]
+**inboundTariffPlanName** | **Array<string>** |  | [optional] [default to undefined]
+**invoiceDescription** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddSipTrunkDDIsRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddSipTrunkDDIsRequest = {
+    startDDI,
+    sipTrunkSdrRefId,
+    connectionDate,
+    endDDI,
+    inboundTariffPlanName,
+    invoiceDescription,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostGetBaseServicesRequest.md

@@ -0,0 +1,22 @@
+# PostGetBaseServicesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**originalDescription** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetBaseServicesRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetBaseServicesRequest = {
+    serviceCode,
+    originalDescription,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostGetPriceGroupsRequest.md

@@ -0,0 +1,22 @@
+# PostGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetPriceGroupsRequest = {
+    name,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostGetServicePlansRequest.md

@@ -0,0 +1,22 @@
+# PostGetServicePlansRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetServicePlansRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetServicePlansRequest = {
+    name,
+    planGroup,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostGetSipTrunksBillingRequest.md

@@ -0,0 +1,34 @@
+# PostGetSipTrunksBillingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parentEndpointId** | **string** |  | [optional] [default to undefined]
+**endpointId** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**callTariffPlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**isMtPrimarySipTrunk** | **boolean** |  | [optional] [default to undefined]
+**mtPrimarySipTrunkId** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetSipTrunksBillingRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetSipTrunksBillingRequest = {
+    parentEndpointId,
+    endpointId,
+    connectionDate,
+    servicePlanName,
+    callTariffPlanName,
+    invoiceDescription,
+    isMtPrimarySipTrunk,
+    mtPrimarySipTrunkId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostUpdateConnectionRequest.md

@@ -0,0 +1,22 @@
+# PostUpdateConnectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostUpdateConnectionRequest } from 'yellowgrid-api-ts';
+
+const instance: PostUpdateConnectionRequest = {
+    property,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PostUpdateRecurringChargeRequest.md

@@ -0,0 +1,30 @@
+# PostUpdateRecurringChargeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**endPeriod** | **string** | Date Time | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostUpdateRecurringChargeRequest } from 'yellowgrid-api-ts';
+
+const instance: PostUpdateRecurringChargeRequest = {
+    reference,
+    description,
+    customerCharge,
+    quantity,
+    endPeriod,
+    accountCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PriceGroup.md

@@ -0,0 +1,30 @@
+# PriceGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**category** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PriceGroup } from 'yellowgrid-api-ts';
+
+const instance: PriceGroup = {
+    createdDate,
+    id,
+    name,
+    category,
+    description,
+    filePeriod,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProcessedCdr.md

@@ -0,0 +1,96 @@
+# ProcessedCdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**cdrId** | **number** |  | [optional] [default to undefined]
+**cdr** | [**Cdr**](Cdr.md) |  | [optional] [default to undefined]
+**contentReference** | **string** |  | [optional] [default to undefined]
+**callClass** | **string** |  | [optional] [default to undefined]
+**inbound** | **boolean** |  | [optional] [default to undefined]
+**cli** | **string** |  | [optional] [default to undefined]
+**presentationNumber** | **string** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**mtPrimaryOutboundCliId** | **number** |  | [optional] [default to undefined]
+**mtPrimaryOutboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) |  | [optional] [default to undefined]
+**callTariffId** | **number** |  | [optional] [default to undefined]
+**callTariff** | [**CallTariff**](CallTariff.md) |  | [optional] [default to undefined]
+**customerChargePreRounded** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**customerChargePostBundle** | **number** |  | [optional] [default to undefined]
+**bundleName** | **string** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**tariffPlanName** | **string** |  | [optional] [default to undefined]
+**chargecode** | **string** |  | [optional] [default to undefined]
+**priceGroupName** | **string** |  | [optional] [default to undefined]
+**unknownDestRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**ngcsAcsChgPerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAcsChgPerCall** | **number** |  | [optional] [default to undefined]
+**customerNGCSAcssChg** | **number** |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**salesprice** | **number** |  | [optional] [default to undefined]
+**callDateTime** | **string** |  | [optional] [default to undefined]
+**duration** | **number** |  | [optional] [default to undefined]
+**ngcsServiceCharge** | **number** |  | [optional] [default to undefined]
+**cdrDescription** | **string** |  | [optional] [default to undefined]
+**calledNumber** | **string** |  | [optional] [default to undefined]
+**remarks** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProcessedCdr } from 'yellowgrid-api-ts';
+
+const instance: ProcessedCdr = {
+    id,
+    cdrId,
+    cdr,
+    contentReference,
+    callClass,
+    inbound,
+    cli,
+    presentationNumber,
+    outboundCliId,
+    outboundCli,
+    mtPrimaryOutboundCliId,
+    mtPrimaryOutboundCli,
+    callTariffPlanId,
+    callTariffPlan,
+    inboundTariffPlanId,
+    inboundTariffPlan,
+    callTariffId,
+    callTariff,
+    customerChargePreRounded,
+    customerCharge,
+    customerChargePostBundle,
+    bundleName,
+    customerId,
+    tariffPlanName,
+    chargecode,
+    priceGroupName,
+    unknownDestRate,
+    ngcsAcsChgPerMin,
+    ngcsAcsChgPerCall,
+    customerNGCSAcssChg,
+    customerRate,
+    salesprice,
+    callDateTime,
+    duration,
+    ngcsServiceCharge,
+    cdrDescription,
+    calledNumber,
+    remarks,
+    filePeriod,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutAddCallTariffToCallTariffPlanRequest.md

@@ -0,0 +1,30 @@
+# PutAddCallTariffToCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tariffRateMarkup** | **string** |  | [optional] [default to undefined]
+**tariffRateDay** | **number** |  | [optional] [default to undefined]
+**tariffRateEvening** | **number** |  | [optional] [default to undefined]
+**tariffRateWeekend** | **number** |  | [optional] [default to undefined]
+**tariffRateMinimum** | **number** |  | [optional] [default to undefined]
+**tariffRateSetup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddCallTariffToCallTariffPlanRequest = {
+    tariffRateMarkup,
+    tariffRateDay,
+    tariffRateEvening,
+    tariffRateWeekend,
+    tariffRateMinimum,
+    tariffRateSetup,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutAddServiceToServicePlanRequest.md

@@ -0,0 +1,26 @@
+# PutAddServiceToServicePlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerRate_Markup** | **string** |  | [optional] [default to undefined]
+**customerRate_Amount** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddServiceToServicePlanRequest = {
+    customerRate_Markup,
+    customerRate_Amount,
+    description,
+    hideOnInvoice,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutConnectionSearchRequest.md

@@ -0,0 +1,20 @@
+# PutConnectionSearchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutConnectionSearchRequest } from 'yellowgrid-api-ts';
+
+const instance: PutConnectionSearchRequest = {
+    customerId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutGetBaseServicesRequest.md

@@ -0,0 +1,28 @@
+# PutGetBaseServicesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**serviceCodeAdmin** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**dataType** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetBaseServicesRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetBaseServicesRequest = {
+    property,
+    value,
+    serviceCodeAdmin,
+    description,
+    dataType,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutGetCallTariffPlanRequest.md

@@ -0,0 +1,28 @@
+# PutGetCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateType** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetCallTariffPlanRequest = {
+    name,
+    unknownDestinationsRateType,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PutGetPriceGroupsRequest.md

@@ -0,0 +1,28 @@
+# PutGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetPriceGroupsRequest = {
+    property,
+    value,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RecurringCharge.md

@@ -0,0 +1,48 @@
+# RecurringCharge
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [default to undefined]
+**phoneNumber** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**channelPartnerBuy** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RecurringCharge } from 'yellowgrid-api-ts';
+
+const instance: RecurringCharge = {
+    createdDate,
+    id,
+    customerId,
+    customer,
+    phoneNumber,
+    description,
+    channelPartnerBuy,
+    customerCharge,
+    frequency,
+    startDate,
+    endDate,
+    quantity,
+    accountCode,
+    filePeriod,
+    isActive,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)