Skip to content

Commit

Permalink
feat(clients): update models as of 2024-11-08 (#1355)
Browse files Browse the repository at this point in the history
Co-authored-by: tusbar <[email protected]>
  • Loading branch information
bizon-bot and tusbar authored Nov 11, 2024
1 parent 709bf50 commit 4738e78
Show file tree
Hide file tree
Showing 85 changed files with 262 additions and 256 deletions.
2 changes: 1 addition & 1 deletion clients/finances-api-v0/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `finances-api-v0`

The Selling Partner API for Finances provides financial information that is relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.

[![npm version](https://badgen.net/npm/v/@sp-api-sdk/finances-api-v0)](https://www.npmjs.com/package/@sp-api-sdk/finances-api-v0)
[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
Expand Down
2 changes: 1 addition & 1 deletion clients/finances-api-v0/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@sp-api-sdk/finances-api-v0",
"author": "Bertrand Marron <[email protected]>",
"description": "The Selling Partner API for Finances provides financial information that is relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
"description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
"version": "2.6.2",
"main": "dist/cjs/index.js",
"module": "dist/es/index.js",
Expand Down
2 changes: 1 addition & 1 deletion clients/finances-api-v0/src/api-model/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down
118 changes: 59 additions & 59 deletions clients/finances-api-v0/src/api-model/api/default-api.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion clients/finances-api-v0/src/api-model/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down
2 changes: 1 addition & 1 deletion clients/finances-api-v0/src/api-model/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down
2 changes: 1 addition & 1 deletion clients/finances-api-v0/src/api-model/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down
2 changes: 1 addition & 1 deletion clients/finances-api-v0/src/api-model/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand All @@ -24,13 +24,13 @@ import type { Currency } from './currency';
*/
export interface AdhocDisbursementEvent {
/**
* The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\".
* Indicates the type of transaction. Example: \"Disbursed to Amazon Gift Card balance\"
* @type {string}
* @memberof AdhocDisbursementEvent
*/
'TransactionType'?: string;
/**
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AdhocDisbursementEvent
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand All @@ -27,13 +27,13 @@ import type { Currency } from './currency';
*/
export interface AdjustmentEvent {
/**
* The type of adjustment. Possible values: * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller\'s account is held back. * `PostageBilling`: The amount paid by a seller for shipping labels. * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded. * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * `SellerRewards`: An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.
* The type of adjustment. Possible values: * FBAInventoryReimbursement - An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller\'s account is held back. * PostageBilling - The amount paid by a seller for shipping labels. * PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded. * LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * SellerRewards - An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.
* @type {string}
* @memberof AdjustmentEvent
*/
'AdjustmentType'?: string;
/**
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AdjustmentEvent
*/
Expand Down
10 changes: 8 additions & 2 deletions clients/finances-api-v0/src/api-model/models/adjustment-item.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand All @@ -24,7 +24,7 @@ import type { Currency } from './currency';
*/
export interface AdjustmentItem {
/**
* Represents the number of units in the seller\'s inventory when the `AdjustmentType` is `FBAInventoryReimbursement`.
* Represents the number of units in the seller\'s inventory when the AdustmentType is FBAInventoryReimbursement.
* @type {string}
* @memberof AdjustmentItem
*/
Expand Down Expand Up @@ -65,5 +65,11 @@ export interface AdjustmentItem {
* @memberof AdjustmentItem
*/
'ASIN'?: string;
/**
* The transaction number that is related to the adjustment.
* @type {string}
* @memberof AdjustmentItem
*/
'TransactionNumber'?: string;
}

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand Down Expand Up @@ -30,19 +30,19 @@ export interface AffordabilityExpenseEvent {
*/
'AmazonOrderId'?: string;
/**
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
'PostedDate'?: string;
/**
* The Amazon-defined marketplace identifier.
* An encrypted, Amazon-defined marketplace identifier.
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
'MarketplaceId'?: string;
/**
* The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal.
* Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.
* @type {string}
* @memberof AffordabilityExpenseEvent
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* eslint-disable */
/**
* Selling Partner API for Finances
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
*
* The version of the OpenAPI document: v0
*
Expand All @@ -24,13 +24,13 @@ import type { Currency } from './currency';
*/
export interface CapacityReservationBillingEvent {
/**
* The transaction type. For example, FBA Inventory Fee.
* Indicates the type of transaction. For example, FBA Inventory Fee
* @type {string}
* @memberof CapacityReservationBillingEvent
*/
'TransactionType'?: string;
/**
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
* @type {string}
* @memberof CapacityReservationBillingEvent
*/
Expand Down
Loading

0 comments on commit 4738e78

Please sign in to comment.