@amos.com/node 0.1.6 → 0.1.8

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/dist/index.d.mts CHANGED
@@ -104,13 +104,13 @@ interface paths {
104
104
  };
105
105
  /** Retrieve a customer by ID */
106
106
  get: operations["GetCustomer"];
107
- put?: never;
107
+ /** Update a customer by ID */
108
+ put: operations["UpdateCustomer"];
108
109
  post?: never;
109
110
  delete?: never;
110
111
  options?: never;
111
112
  head?: never;
112
- /** Update a customer by ID */
113
- patch: operations["UpdateCustomer"];
113
+ patch?: never;
114
114
  trace?: never;
115
115
  };
116
116
  "/external_accounts": {
@@ -723,13 +723,13 @@ interface paths {
723
723
  cookie?: never;
724
724
  };
725
725
  get?: never;
726
- put?: never;
726
+ /** Update a product by ID */
727
+ put: operations["UpdateProduct"];
727
728
  post?: never;
728
729
  delete?: never;
729
730
  options?: never;
730
731
  head?: never;
731
- /** Update a product by ID */
732
- patch: operations["UpdateProduct"];
732
+ patch?: never;
733
733
  trace?: never;
734
734
  };
735
735
  "/refunds": {
@@ -950,7 +950,25 @@ interface paths {
950
950
  };
951
951
  /** Retrieve a subscription by ID */
952
952
  get: operations["GetSubscription"];
953
- put?: never;
953
+ /** Update a subscription by ID */
954
+ put: operations["UpdateSubscription"];
955
+ post?: never;
956
+ delete?: never;
957
+ options?: never;
958
+ head?: never;
959
+ patch?: never;
960
+ trace?: never;
961
+ };
962
+ "/subscriptions/{id}/skip": {
963
+ parameters: {
964
+ query?: never;
965
+ header?: never;
966
+ path?: never;
967
+ cookie?: never;
968
+ };
969
+ get?: never;
970
+ /** Skip subscription billing periods by ID */
971
+ put: operations["SkipSubscription"];
954
972
  post?: never;
955
973
  delete?: never;
956
974
  options?: never;
@@ -1276,6 +1294,8 @@ interface components {
1276
1294
  /** Format: uuid */
1277
1295
  customer_id?: string;
1278
1296
  description?: string | null;
1297
+ failure_code?: string | null;
1298
+ failure_reason?: string | null;
1279
1299
  /** @enum {string|null} */
1280
1300
  allowed_reverse_action?: "void" | "refund" | null;
1281
1301
  metadata?: components["schemas"]["Metadata"];
@@ -1312,14 +1332,12 @@ interface components {
1312
1332
  customer: components["schemas"]["CreateCustomerInput"];
1313
1333
  };
1314
1334
  UpdateCustomerInput: {
1315
- /** Format: uuid */
1316
- account_id?: string;
1317
- name?: string;
1318
1335
  email?: string;
1319
- metadata?: components["schemas"]["Metadata"];
1320
- phone?: string;
1336
+ name?: string;
1321
1337
  /** Format: uuid */
1322
1338
  payment_method_id?: string;
1339
+ phone?: string;
1340
+ metadata?: components["schemas"]["Metadata"];
1323
1341
  };
1324
1342
  UpdateCustomerRequest: {
1325
1343
  customer: components["schemas"]["UpdateCustomerInput"];
@@ -1561,7 +1579,7 @@ interface components {
1561
1579
  bank_account_number?: string;
1562
1580
  bank_routing_number?: string;
1563
1581
  /** @enum {string} */
1564
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1582
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1565
1583
  business_description?: string;
1566
1584
  city?: string;
1567
1585
  country_code?: string;
@@ -1588,7 +1606,7 @@ interface components {
1588
1606
  id?: string;
1589
1607
  annual_credit_card_sales_volume?: number;
1590
1608
  /** @enum {string} */
1591
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1609
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1592
1610
  business_description?: string;
1593
1611
  city?: string;
1594
1612
  country_code?: string;
@@ -1784,6 +1802,8 @@ interface components {
1784
1802
  external_account_id: string;
1785
1803
  amount: number;
1786
1804
  currency?: string;
1805
+ /** @enum {string} */
1806
+ direction: "credit" | "debit";
1787
1807
  metadata?: components["schemas"]["Metadata"];
1788
1808
  };
1789
1809
  CreatePayoutRequest: {
@@ -1796,6 +1816,8 @@ interface components {
1796
1816
  external_account_id: string;
1797
1817
  amount: number;
1798
1818
  currency?: string;
1819
+ /** @enum {string} */
1820
+ direction: "credit" | "debit";
1799
1821
  metadata?: components["schemas"]["Metadata"];
1800
1822
  };
1801
1823
  CreateBulkPayoutsRequest: {
@@ -1810,6 +1832,8 @@ interface components {
1810
1832
  external_account_id?: string;
1811
1833
  amount?: number;
1812
1834
  currency?: string;
1835
+ /** @enum {string} */
1836
+ direction?: "credit" | "debit";
1813
1837
  metadata?: components["schemas"]["Metadata"];
1814
1838
  /** @enum {string} */
1815
1839
  state?: "pending" | "succeeded" | "failed" | "accepted" | "rejected";
@@ -1907,6 +1931,8 @@ interface components {
1907
1931
  /** Format: uuid */
1908
1932
  customer_id?: string;
1909
1933
  description?: string | null;
1934
+ failure_code?: string | null;
1935
+ failure_reason?: string | null;
1910
1936
  metadata?: components["schemas"]["Metadata"];
1911
1937
  /** Format: uuid */
1912
1938
  original_transaction_id?: string;
@@ -2001,6 +2027,20 @@ interface components {
2001
2027
  CreateSubscriptionRequest: {
2002
2028
  subscription: components["schemas"]["CreateSubscriptionInput"];
2003
2029
  };
2030
+ UpdateSubscriptionInput: {
2031
+ /** Format: uuid */
2032
+ payment_method_id?: string;
2033
+ metadata?: components["schemas"]["Metadata"];
2034
+ };
2035
+ UpdateSubscriptionRequest: {
2036
+ subscription: components["schemas"]["UpdateSubscriptionInput"];
2037
+ };
2038
+ SkipSubscriptionInput: {
2039
+ period_count?: number;
2040
+ };
2041
+ SkipSubscriptionRequest: {
2042
+ subscription: components["schemas"]["SkipSubscriptionInput"];
2043
+ };
2004
2044
  Subscription: {
2005
2045
  /** Format: uuid */
2006
2046
  id?: string;
@@ -2021,6 +2061,8 @@ interface components {
2021
2061
  /** @enum {string} */
2022
2062
  state?: "active" | "paused" | "past_due" | "cancelled";
2023
2063
  cycles_completed?: number;
2064
+ skip_billing_periods_remaining?: number;
2065
+ skipped_billing_periods_count?: number;
2024
2066
  /** Format: date-time */
2025
2067
  current_billing_period_start?: string;
2026
2068
  /** Format: date-time */
@@ -2112,6 +2154,8 @@ interface components {
2112
2154
  /** Format: uuid */
2113
2155
  customer_id?: string;
2114
2156
  description?: string | null;
2157
+ failure_code?: string | null;
2158
+ failure_reason?: string | null;
2115
2159
  metadata?: components["schemas"]["Metadata"];
2116
2160
  /** Format: uuid */
2117
2161
  original_transaction_id?: string;
@@ -2150,7 +2194,7 @@ interface components {
2150
2194
  updated_at?: string;
2151
2195
  };
2152
2196
  CreateWebhookEndpointInput: {
2153
- event?: string;
2197
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2154
2198
  metadata?: components["schemas"]["Metadata"];
2155
2199
  active?: boolean;
2156
2200
  url?: string;
@@ -2161,7 +2205,7 @@ interface components {
2161
2205
  WebhookEndpoint: {
2162
2206
  /** Format: uuid */
2163
2207
  id?: string;
2164
- event?: string;
2208
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2165
2209
  metadata?: components["schemas"]["Metadata"];
2166
2210
  secret?: string;
2167
2211
  url?: string;
@@ -4278,6 +4322,78 @@ interface operations {
4278
4322
  };
4279
4323
  };
4280
4324
  };
4325
+ UpdateSubscription: {
4326
+ parameters: {
4327
+ query?: never;
4328
+ header?: never;
4329
+ path: {
4330
+ /** @description The ID of the subscription to update */
4331
+ id: string;
4332
+ };
4333
+ cookie?: never;
4334
+ };
4335
+ requestBody: {
4336
+ content: {
4337
+ "application/json": components["schemas"]["UpdateSubscriptionRequest"];
4338
+ };
4339
+ };
4340
+ responses: {
4341
+ /** @description Subscription updated successfully */
4342
+ 200: {
4343
+ headers: {
4344
+ [name: string]: unknown;
4345
+ };
4346
+ content: {
4347
+ "application/json": components["schemas"]["Subscription"];
4348
+ };
4349
+ };
4350
+ /** @description Unprocessable entity */
4351
+ 422: {
4352
+ headers: {
4353
+ [name: string]: unknown;
4354
+ };
4355
+ content: {
4356
+ "application/json": components["schemas"]["Error"];
4357
+ };
4358
+ };
4359
+ };
4360
+ };
4361
+ SkipSubscription: {
4362
+ parameters: {
4363
+ query?: never;
4364
+ header?: never;
4365
+ path: {
4366
+ /** @description The ID of the subscription to skip billing periods for */
4367
+ id: string;
4368
+ };
4369
+ cookie?: never;
4370
+ };
4371
+ requestBody: {
4372
+ content: {
4373
+ "application/json": components["schemas"]["SkipSubscriptionRequest"];
4374
+ };
4375
+ };
4376
+ responses: {
4377
+ /** @description Subscription billing periods skipped successfully */
4378
+ 200: {
4379
+ headers: {
4380
+ [name: string]: unknown;
4381
+ };
4382
+ content: {
4383
+ "application/json": components["schemas"]["Subscription"];
4384
+ };
4385
+ };
4386
+ /** @description Unprocessable entity */
4387
+ 422: {
4388
+ headers: {
4389
+ [name: string]: unknown;
4390
+ };
4391
+ content: {
4392
+ "application/json": components["schemas"]["Error"];
4393
+ };
4394
+ };
4395
+ };
4396
+ };
4281
4397
  CancelSubscription: {
4282
4398
  parameters: {
4283
4399
  query?: never;
package/dist/index.d.ts CHANGED
@@ -104,13 +104,13 @@ interface paths {
104
104
  };
105
105
  /** Retrieve a customer by ID */
106
106
  get: operations["GetCustomer"];
107
- put?: never;
107
+ /** Update a customer by ID */
108
+ put: operations["UpdateCustomer"];
108
109
  post?: never;
109
110
  delete?: never;
110
111
  options?: never;
111
112
  head?: never;
112
- /** Update a customer by ID */
113
- patch: operations["UpdateCustomer"];
113
+ patch?: never;
114
114
  trace?: never;
115
115
  };
116
116
  "/external_accounts": {
@@ -723,13 +723,13 @@ interface paths {
723
723
  cookie?: never;
724
724
  };
725
725
  get?: never;
726
- put?: never;
726
+ /** Update a product by ID */
727
+ put: operations["UpdateProduct"];
727
728
  post?: never;
728
729
  delete?: never;
729
730
  options?: never;
730
731
  head?: never;
731
- /** Update a product by ID */
732
- patch: operations["UpdateProduct"];
732
+ patch?: never;
733
733
  trace?: never;
734
734
  };
735
735
  "/refunds": {
@@ -950,7 +950,25 @@ interface paths {
950
950
  };
951
951
  /** Retrieve a subscription by ID */
952
952
  get: operations["GetSubscription"];
953
- put?: never;
953
+ /** Update a subscription by ID */
954
+ put: operations["UpdateSubscription"];
955
+ post?: never;
956
+ delete?: never;
957
+ options?: never;
958
+ head?: never;
959
+ patch?: never;
960
+ trace?: never;
961
+ };
962
+ "/subscriptions/{id}/skip": {
963
+ parameters: {
964
+ query?: never;
965
+ header?: never;
966
+ path?: never;
967
+ cookie?: never;
968
+ };
969
+ get?: never;
970
+ /** Skip subscription billing periods by ID */
971
+ put: operations["SkipSubscription"];
954
972
  post?: never;
955
973
  delete?: never;
956
974
  options?: never;
@@ -1276,6 +1294,8 @@ interface components {
1276
1294
  /** Format: uuid */
1277
1295
  customer_id?: string;
1278
1296
  description?: string | null;
1297
+ failure_code?: string | null;
1298
+ failure_reason?: string | null;
1279
1299
  /** @enum {string|null} */
1280
1300
  allowed_reverse_action?: "void" | "refund" | null;
1281
1301
  metadata?: components["schemas"]["Metadata"];
@@ -1312,14 +1332,12 @@ interface components {
1312
1332
  customer: components["schemas"]["CreateCustomerInput"];
1313
1333
  };
1314
1334
  UpdateCustomerInput: {
1315
- /** Format: uuid */
1316
- account_id?: string;
1317
- name?: string;
1318
1335
  email?: string;
1319
- metadata?: components["schemas"]["Metadata"];
1320
- phone?: string;
1336
+ name?: string;
1321
1337
  /** Format: uuid */
1322
1338
  payment_method_id?: string;
1339
+ phone?: string;
1340
+ metadata?: components["schemas"]["Metadata"];
1323
1341
  };
1324
1342
  UpdateCustomerRequest: {
1325
1343
  customer: components["schemas"]["UpdateCustomerInput"];
@@ -1561,7 +1579,7 @@ interface components {
1561
1579
  bank_account_number?: string;
1562
1580
  bank_routing_number?: string;
1563
1581
  /** @enum {string} */
1564
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1582
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1565
1583
  business_description?: string;
1566
1584
  city?: string;
1567
1585
  country_code?: string;
@@ -1588,7 +1606,7 @@ interface components {
1588
1606
  id?: string;
1589
1607
  annual_credit_card_sales_volume?: number;
1590
1608
  /** @enum {string} */
1591
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1609
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1592
1610
  business_description?: string;
1593
1611
  city?: string;
1594
1612
  country_code?: string;
@@ -1784,6 +1802,8 @@ interface components {
1784
1802
  external_account_id: string;
1785
1803
  amount: number;
1786
1804
  currency?: string;
1805
+ /** @enum {string} */
1806
+ direction: "credit" | "debit";
1787
1807
  metadata?: components["schemas"]["Metadata"];
1788
1808
  };
1789
1809
  CreatePayoutRequest: {
@@ -1796,6 +1816,8 @@ interface components {
1796
1816
  external_account_id: string;
1797
1817
  amount: number;
1798
1818
  currency?: string;
1819
+ /** @enum {string} */
1820
+ direction: "credit" | "debit";
1799
1821
  metadata?: components["schemas"]["Metadata"];
1800
1822
  };
1801
1823
  CreateBulkPayoutsRequest: {
@@ -1810,6 +1832,8 @@ interface components {
1810
1832
  external_account_id?: string;
1811
1833
  amount?: number;
1812
1834
  currency?: string;
1835
+ /** @enum {string} */
1836
+ direction?: "credit" | "debit";
1813
1837
  metadata?: components["schemas"]["Metadata"];
1814
1838
  /** @enum {string} */
1815
1839
  state?: "pending" | "succeeded" | "failed" | "accepted" | "rejected";
@@ -1907,6 +1931,8 @@ interface components {
1907
1931
  /** Format: uuid */
1908
1932
  customer_id?: string;
1909
1933
  description?: string | null;
1934
+ failure_code?: string | null;
1935
+ failure_reason?: string | null;
1910
1936
  metadata?: components["schemas"]["Metadata"];
1911
1937
  /** Format: uuid */
1912
1938
  original_transaction_id?: string;
@@ -2001,6 +2027,20 @@ interface components {
2001
2027
  CreateSubscriptionRequest: {
2002
2028
  subscription: components["schemas"]["CreateSubscriptionInput"];
2003
2029
  };
2030
+ UpdateSubscriptionInput: {
2031
+ /** Format: uuid */
2032
+ payment_method_id?: string;
2033
+ metadata?: components["schemas"]["Metadata"];
2034
+ };
2035
+ UpdateSubscriptionRequest: {
2036
+ subscription: components["schemas"]["UpdateSubscriptionInput"];
2037
+ };
2038
+ SkipSubscriptionInput: {
2039
+ period_count?: number;
2040
+ };
2041
+ SkipSubscriptionRequest: {
2042
+ subscription: components["schemas"]["SkipSubscriptionInput"];
2043
+ };
2004
2044
  Subscription: {
2005
2045
  /** Format: uuid */
2006
2046
  id?: string;
@@ -2021,6 +2061,8 @@ interface components {
2021
2061
  /** @enum {string} */
2022
2062
  state?: "active" | "paused" | "past_due" | "cancelled";
2023
2063
  cycles_completed?: number;
2064
+ skip_billing_periods_remaining?: number;
2065
+ skipped_billing_periods_count?: number;
2024
2066
  /** Format: date-time */
2025
2067
  current_billing_period_start?: string;
2026
2068
  /** Format: date-time */
@@ -2112,6 +2154,8 @@ interface components {
2112
2154
  /** Format: uuid */
2113
2155
  customer_id?: string;
2114
2156
  description?: string | null;
2157
+ failure_code?: string | null;
2158
+ failure_reason?: string | null;
2115
2159
  metadata?: components["schemas"]["Metadata"];
2116
2160
  /** Format: uuid */
2117
2161
  original_transaction_id?: string;
@@ -2150,7 +2194,7 @@ interface components {
2150
2194
  updated_at?: string;
2151
2195
  };
2152
2196
  CreateWebhookEndpointInput: {
2153
- event?: string;
2197
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2154
2198
  metadata?: components["schemas"]["Metadata"];
2155
2199
  active?: boolean;
2156
2200
  url?: string;
@@ -2161,7 +2205,7 @@ interface components {
2161
2205
  WebhookEndpoint: {
2162
2206
  /** Format: uuid */
2163
2207
  id?: string;
2164
- event?: string;
2208
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2165
2209
  metadata?: components["schemas"]["Metadata"];
2166
2210
  secret?: string;
2167
2211
  url?: string;
@@ -4278,6 +4322,78 @@ interface operations {
4278
4322
  };
4279
4323
  };
4280
4324
  };
4325
+ UpdateSubscription: {
4326
+ parameters: {
4327
+ query?: never;
4328
+ header?: never;
4329
+ path: {
4330
+ /** @description The ID of the subscription to update */
4331
+ id: string;
4332
+ };
4333
+ cookie?: never;
4334
+ };
4335
+ requestBody: {
4336
+ content: {
4337
+ "application/json": components["schemas"]["UpdateSubscriptionRequest"];
4338
+ };
4339
+ };
4340
+ responses: {
4341
+ /** @description Subscription updated successfully */
4342
+ 200: {
4343
+ headers: {
4344
+ [name: string]: unknown;
4345
+ };
4346
+ content: {
4347
+ "application/json": components["schemas"]["Subscription"];
4348
+ };
4349
+ };
4350
+ /** @description Unprocessable entity */
4351
+ 422: {
4352
+ headers: {
4353
+ [name: string]: unknown;
4354
+ };
4355
+ content: {
4356
+ "application/json": components["schemas"]["Error"];
4357
+ };
4358
+ };
4359
+ };
4360
+ };
4361
+ SkipSubscription: {
4362
+ parameters: {
4363
+ query?: never;
4364
+ header?: never;
4365
+ path: {
4366
+ /** @description The ID of the subscription to skip billing periods for */
4367
+ id: string;
4368
+ };
4369
+ cookie?: never;
4370
+ };
4371
+ requestBody: {
4372
+ content: {
4373
+ "application/json": components["schemas"]["SkipSubscriptionRequest"];
4374
+ };
4375
+ };
4376
+ responses: {
4377
+ /** @description Subscription billing periods skipped successfully */
4378
+ 200: {
4379
+ headers: {
4380
+ [name: string]: unknown;
4381
+ };
4382
+ content: {
4383
+ "application/json": components["schemas"]["Subscription"];
4384
+ };
4385
+ };
4386
+ /** @description Unprocessable entity */
4387
+ 422: {
4388
+ headers: {
4389
+ [name: string]: unknown;
4390
+ };
4391
+ content: {
4392
+ "application/json": components["schemas"]["Error"];
4393
+ };
4394
+ };
4395
+ };
4396
+ };
4281
4397
  CancelSubscription: {
4282
4398
  parameters: {
4283
4399
  query?: never;
package/openapi/schema.ts CHANGED
@@ -101,13 +101,13 @@ export interface paths {
101
101
  };
102
102
  /** Retrieve a customer by ID */
103
103
  get: operations["GetCustomer"];
104
- put?: never;
104
+ /** Update a customer by ID */
105
+ put: operations["UpdateCustomer"];
105
106
  post?: never;
106
107
  delete?: never;
107
108
  options?: never;
108
109
  head?: never;
109
- /** Update a customer by ID */
110
- patch: operations["UpdateCustomer"];
110
+ patch?: never;
111
111
  trace?: never;
112
112
  };
113
113
  "/external_accounts": {
@@ -720,13 +720,13 @@ export interface paths {
720
720
  cookie?: never;
721
721
  };
722
722
  get?: never;
723
- put?: never;
723
+ /** Update a product by ID */
724
+ put: operations["UpdateProduct"];
724
725
  post?: never;
725
726
  delete?: never;
726
727
  options?: never;
727
728
  head?: never;
728
- /** Update a product by ID */
729
- patch: operations["UpdateProduct"];
729
+ patch?: never;
730
730
  trace?: never;
731
731
  };
732
732
  "/refunds": {
@@ -947,7 +947,25 @@ export interface paths {
947
947
  };
948
948
  /** Retrieve a subscription by ID */
949
949
  get: operations["GetSubscription"];
950
- put?: never;
950
+ /** Update a subscription by ID */
951
+ put: operations["UpdateSubscription"];
952
+ post?: never;
953
+ delete?: never;
954
+ options?: never;
955
+ head?: never;
956
+ patch?: never;
957
+ trace?: never;
958
+ };
959
+ "/subscriptions/{id}/skip": {
960
+ parameters: {
961
+ query?: never;
962
+ header?: never;
963
+ path?: never;
964
+ cookie?: never;
965
+ };
966
+ get?: never;
967
+ /** Skip subscription billing periods by ID */
968
+ put: operations["SkipSubscription"];
951
969
  post?: never;
952
970
  delete?: never;
953
971
  options?: never;
@@ -1273,6 +1291,8 @@ export interface components {
1273
1291
  /** Format: uuid */
1274
1292
  customer_id?: string;
1275
1293
  description?: string | null;
1294
+ failure_code?: string | null;
1295
+ failure_reason?: string | null;
1276
1296
  /** @enum {string|null} */
1277
1297
  allowed_reverse_action?: "void" | "refund" | null;
1278
1298
  metadata?: components["schemas"]["Metadata"];
@@ -1309,14 +1329,12 @@ export interface components {
1309
1329
  customer: components["schemas"]["CreateCustomerInput"];
1310
1330
  };
1311
1331
  UpdateCustomerInput: {
1312
- /** Format: uuid */
1313
- account_id?: string;
1314
- name?: string;
1315
1332
  email?: string;
1316
- metadata?: components["schemas"]["Metadata"];
1317
- phone?: string;
1333
+ name?: string;
1318
1334
  /** Format: uuid */
1319
1335
  payment_method_id?: string;
1336
+ phone?: string;
1337
+ metadata?: components["schemas"]["Metadata"];
1320
1338
  };
1321
1339
  UpdateCustomerRequest: {
1322
1340
  customer: components["schemas"]["UpdateCustomerInput"];
@@ -1558,7 +1576,7 @@ export interface components {
1558
1576
  bank_account_number?: string;
1559
1577
  bank_routing_number?: string;
1560
1578
  /** @enum {string} */
1561
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1579
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1562
1580
  business_description?: string;
1563
1581
  city?: string;
1564
1582
  country_code?: string;
@@ -1585,7 +1603,7 @@ export interface components {
1585
1603
  id?: string;
1586
1604
  annual_credit_card_sales_volume?: number;
1587
1605
  /** @enum {string} */
1588
- business_category?: "sporting_goods" | "services" | "medical" | "charity" | "civic" | "political" | "religious";
1606
+ business_category?: "business_association" | "charity" | "church" | "county" | "federal" | "fraternal_org" | "government" | "higher_education" | "k12" | "labor_union" | "local" | "ministry" | "pac" | "parachurch" | "party" | "preschool" | "social_club" | "social_welfare" | "state" | "tribal" | "vendor" | "veterans_org";
1589
1607
  business_description?: string;
1590
1608
  city?: string;
1591
1609
  country_code?: string;
@@ -1781,6 +1799,8 @@ export interface components {
1781
1799
  external_account_id: string;
1782
1800
  amount: number;
1783
1801
  currency?: string;
1802
+ /** @enum {string} */
1803
+ direction: "credit" | "debit";
1784
1804
  metadata?: components["schemas"]["Metadata"];
1785
1805
  };
1786
1806
  CreatePayoutRequest: {
@@ -1793,6 +1813,8 @@ export interface components {
1793
1813
  external_account_id: string;
1794
1814
  amount: number;
1795
1815
  currency?: string;
1816
+ /** @enum {string} */
1817
+ direction: "credit" | "debit";
1796
1818
  metadata?: components["schemas"]["Metadata"];
1797
1819
  };
1798
1820
  CreateBulkPayoutsRequest: {
@@ -1807,6 +1829,8 @@ export interface components {
1807
1829
  external_account_id?: string;
1808
1830
  amount?: number;
1809
1831
  currency?: string;
1832
+ /** @enum {string} */
1833
+ direction?: "credit" | "debit";
1810
1834
  metadata?: components["schemas"]["Metadata"];
1811
1835
  /** @enum {string} */
1812
1836
  state?: "pending" | "succeeded" | "failed" | "accepted" | "rejected";
@@ -1904,6 +1928,8 @@ export interface components {
1904
1928
  /** Format: uuid */
1905
1929
  customer_id?: string;
1906
1930
  description?: string | null;
1931
+ failure_code?: string | null;
1932
+ failure_reason?: string | null;
1907
1933
  metadata?: components["schemas"]["Metadata"];
1908
1934
  /** Format: uuid */
1909
1935
  original_transaction_id?: string;
@@ -1998,6 +2024,20 @@ export interface components {
1998
2024
  CreateSubscriptionRequest: {
1999
2025
  subscription: components["schemas"]["CreateSubscriptionInput"];
2000
2026
  };
2027
+ UpdateSubscriptionInput: {
2028
+ /** Format: uuid */
2029
+ payment_method_id?: string;
2030
+ metadata?: components["schemas"]["Metadata"];
2031
+ };
2032
+ UpdateSubscriptionRequest: {
2033
+ subscription: components["schemas"]["UpdateSubscriptionInput"];
2034
+ };
2035
+ SkipSubscriptionInput: {
2036
+ period_count?: number;
2037
+ };
2038
+ SkipSubscriptionRequest: {
2039
+ subscription: components["schemas"]["SkipSubscriptionInput"];
2040
+ };
2001
2041
  Subscription: {
2002
2042
  /** Format: uuid */
2003
2043
  id?: string;
@@ -2018,6 +2058,8 @@ export interface components {
2018
2058
  /** @enum {string} */
2019
2059
  state?: "active" | "paused" | "past_due" | "cancelled";
2020
2060
  cycles_completed?: number;
2061
+ skip_billing_periods_remaining?: number;
2062
+ skipped_billing_periods_count?: number;
2021
2063
  /** Format: date-time */
2022
2064
  current_billing_period_start?: string;
2023
2065
  /** Format: date-time */
@@ -2109,6 +2151,8 @@ export interface components {
2109
2151
  /** Format: uuid */
2110
2152
  customer_id?: string;
2111
2153
  description?: string | null;
2154
+ failure_code?: string | null;
2155
+ failure_reason?: string | null;
2112
2156
  metadata?: components["schemas"]["Metadata"];
2113
2157
  /** Format: uuid */
2114
2158
  original_transaction_id?: string;
@@ -2147,7 +2191,7 @@ export interface components {
2147
2191
  updated_at?: string;
2148
2192
  };
2149
2193
  CreateWebhookEndpointInput: {
2150
- event?: string;
2194
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2151
2195
  metadata?: components["schemas"]["Metadata"];
2152
2196
  active?: boolean;
2153
2197
  url?: string;
@@ -2158,7 +2202,7 @@ export interface components {
2158
2202
  WebhookEndpoint: {
2159
2203
  /** Format: uuid */
2160
2204
  id?: string;
2161
- event?: string;
2205
+ events?: ("charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded")[];
2162
2206
  metadata?: components["schemas"]["Metadata"];
2163
2207
  secret?: string;
2164
2208
  url?: string;
@@ -4275,6 +4319,78 @@ export interface operations {
4275
4319
  };
4276
4320
  };
4277
4321
  };
4322
+ UpdateSubscription: {
4323
+ parameters: {
4324
+ query?: never;
4325
+ header?: never;
4326
+ path: {
4327
+ /** @description The ID of the subscription to update */
4328
+ id: string;
4329
+ };
4330
+ cookie?: never;
4331
+ };
4332
+ requestBody: {
4333
+ content: {
4334
+ "application/json": components["schemas"]["UpdateSubscriptionRequest"];
4335
+ };
4336
+ };
4337
+ responses: {
4338
+ /** @description Subscription updated successfully */
4339
+ 200: {
4340
+ headers: {
4341
+ [name: string]: unknown;
4342
+ };
4343
+ content: {
4344
+ "application/json": components["schemas"]["Subscription"];
4345
+ };
4346
+ };
4347
+ /** @description Unprocessable entity */
4348
+ 422: {
4349
+ headers: {
4350
+ [name: string]: unknown;
4351
+ };
4352
+ content: {
4353
+ "application/json": components["schemas"]["Error"];
4354
+ };
4355
+ };
4356
+ };
4357
+ };
4358
+ SkipSubscription: {
4359
+ parameters: {
4360
+ query?: never;
4361
+ header?: never;
4362
+ path: {
4363
+ /** @description The ID of the subscription to skip billing periods for */
4364
+ id: string;
4365
+ };
4366
+ cookie?: never;
4367
+ };
4368
+ requestBody: {
4369
+ content: {
4370
+ "application/json": components["schemas"]["SkipSubscriptionRequest"];
4371
+ };
4372
+ };
4373
+ responses: {
4374
+ /** @description Subscription billing periods skipped successfully */
4375
+ 200: {
4376
+ headers: {
4377
+ [name: string]: unknown;
4378
+ };
4379
+ content: {
4380
+ "application/json": components["schemas"]["Subscription"];
4381
+ };
4382
+ };
4383
+ /** @description Unprocessable entity */
4384
+ 422: {
4385
+ headers: {
4386
+ [name: string]: unknown;
4387
+ };
4388
+ content: {
4389
+ "application/json": components["schemas"]["Error"];
4390
+ };
4391
+ };
4392
+ };
4393
+ };
4278
4394
  CancelSubscription: {
4279
4395
  parameters: {
4280
4396
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amos.com/node",
3
- "version": "0.1.6",
3
+ "version": "0.1.8",
4
4
  "description": "Node.js client for the Amos Pay API.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",