@kard-financial/sdk 16.1.0 → 16.1.2

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.
Files changed (24) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/transactions/client/Client.d.ts +11 -1
  3. package/dist/cjs/api/resources/transactions/client/Client.js +11 -1
  4. package/dist/cjs/api/resources/transactions/types/FileUploadType.d.ts +1 -1
  5. package/dist/cjs/api/resources/transactions/types/FileUploadType.js +1 -1
  6. package/dist/cjs/api/resources/users/resources/rewards/types/LocationsResponseObject.d.ts +6 -6
  7. package/dist/cjs/api/resources/users/resources/rewards/types/OffersResponseObject.d.ts +6 -6
  8. package/dist/cjs/api/resources/users/resources/uploads/client/Client.d.ts +12 -0
  9. package/dist/cjs/api/resources/users/resources/uploads/client/Client.js +12 -0
  10. package/dist/cjs/version.d.ts +1 -1
  11. package/dist/cjs/version.js +1 -1
  12. package/dist/esm/BaseClient.mjs +2 -2
  13. package/dist/esm/api/resources/transactions/client/Client.d.mts +11 -1
  14. package/dist/esm/api/resources/transactions/client/Client.mjs +11 -1
  15. package/dist/esm/api/resources/transactions/types/FileUploadType.d.mts +1 -1
  16. package/dist/esm/api/resources/transactions/types/FileUploadType.mjs +1 -1
  17. package/dist/esm/api/resources/users/resources/rewards/types/LocationsResponseObject.d.mts +6 -6
  18. package/dist/esm/api/resources/users/resources/rewards/types/OffersResponseObject.d.mts +6 -6
  19. package/dist/esm/api/resources/users/resources/uploads/client/Client.d.mts +12 -0
  20. package/dist/esm/api/resources/users/resources/uploads/client/Client.mjs +12 -0
  21. package/dist/esm/version.d.mts +1 -1
  22. package/dist/esm/version.mjs +1 -1
  23. package/package.json +1 -1
  24. package/reference.md +8 -2
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@kard-financial/sdk",
46
- "X-Fern-SDK-Version": "16.1.0",
47
- "User-Agent": "@kard-financial/sdk/16.1.0",
46
+ "X-Fern-SDK-Version": "16.1.2",
47
+ "User-Agent": "@kard-financial/sdk/16.1.2",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -238,7 +238,7 @@ export declare class TransactionsClient {
238
238
  * to storage. Each URL is valid for 15 minutes. Use the returned URL to upload the file via an HTTP PUT request with the
239
239
  * binary file content as the body. If a URL expires before the upload completes, you must request a new one.
240
240
  * Files can be uploaded as plain JSONL or as a gzip-compressed file.
241
- * Only `coreTransaction` type is supported for bulk file uploads.
241
+ * Supports both `incomingTransactionsFile` for daily transaction ingestion and `historicalTransactionsFile` for historical transaction ingestion. See the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide for details on the historical flow.
242
242
  * <b>Required scopes:</b> `transaction:write`
243
243
  *
244
244
  * @param {KardApi.OrganizationId} organizationId
@@ -264,6 +264,16 @@ export declare class TransactionsClient {
264
264
  * }
265
265
  * }]
266
266
  * })
267
+ *
268
+ * @example
269
+ * await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
270
+ * data: [{
271
+ * type: "historicalTransactionsFile",
272
+ * attributes: {
273
+ * filename: "historical_transactions_2024-10-15.jsonl"
274
+ * }
275
+ * }]
276
+ * })
267
277
  */
268
278
  createBulkTransactionsUploadUrl(organizationId: KardApi.OrganizationId, request: KardApi.CreateFileUploadRequestBody, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<KardApi.CreateFileUploadUrlResponse>;
269
279
  private __createBulkTransactionsUploadUrl;
@@ -421,7 +421,7 @@ class TransactionsClient {
421
421
  * to storage. Each URL is valid for 15 minutes. Use the returned URL to upload the file via an HTTP PUT request with the
422
422
  * binary file content as the body. If a URL expires before the upload completes, you must request a new one.
423
423
  * Files can be uploaded as plain JSONL or as a gzip-compressed file.
424
- * Only `coreTransaction` type is supported for bulk file uploads.
424
+ * Supports both `incomingTransactionsFile` for daily transaction ingestion and `historicalTransactionsFile` for historical transaction ingestion. See the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide for details on the historical flow.
425
425
  * <b>Required scopes:</b> `transaction:write`
426
426
  *
427
427
  * @param {KardApi.OrganizationId} organizationId
@@ -447,6 +447,16 @@ class TransactionsClient {
447
447
  * }
448
448
  * }]
449
449
  * })
450
+ *
451
+ * @example
452
+ * await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
453
+ * data: [{
454
+ * type: "historicalTransactionsFile",
455
+ * attributes: {
456
+ * filename: "historical_transactions_2024-10-15.jsonl"
457
+ * }
458
+ * }]
459
+ * })
450
460
  */
451
461
  createBulkTransactionsUploadUrl(organizationId, request, requestOptions) {
452
462
  return core.HttpResponsePromise.fromPromise(this.__createBulkTransactionsUploadUrl(organizationId, request, requestOptions));
@@ -1,4 +1,4 @@
1
- /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for back-filled or retroactive transaction data that covers a past time period. */
1
+ /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for historical transaction ingestion. */
2
2
  export declare const FileUploadType: {
3
3
  readonly IncomingTransactionsFile: "incomingTransactionsFile";
4
4
  readonly HistoricalTransactionsFile: "historicalTransactionsFile";
@@ -2,7 +2,7 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.FileUploadType = void 0;
5
- /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for back-filled or retroactive transaction data that covers a past time period. */
5
+ /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for historical transaction ingestion. */
6
6
  exports.FileUploadType = {
7
7
  IncomingTransactionsFile: "incomingTransactionsFile",
8
8
  HistoricalTransactionsFile: "historicalTransactionsFile",
@@ -121,13 +121,13 @@ import type * as KardApi from "../../../../../index.js";
121
121
  * maxRedemptions: 1,
122
122
  * isTargeted: true,
123
123
  * assets: [{
124
- * type: "IMG_VIEW",
125
- * url: "http://assets.getkard.com/logo/img?attribution-tokens",
126
- * alt: "Worlds Greatest Chicken Logo Image"
124
+ * url: "http://attribution.getkard.com/logos/breakfastbunny_logo.png?subtype=IMG_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
125
+ * alt: "",
126
+ * type: "IMG_VIEW"
127
127
  * }, {
128
- * type: "BANNER_VIEW",
129
- * url: "http://assets.getkard.com/banner/img?attribution-tokens",
130
- * alt: "Worlds Greatest Chicken Banner Image"
128
+ * url: "https://attribution.getkard.com/public/banners/breakfast-bunny-banner.jpg?subtype=BANNER_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
129
+ * alt: "",
130
+ * type: "BANNER_VIEW"
131
131
  * }],
132
132
  * websiteUrl: "http://worldsgreatestchickent.test.com",
133
133
  * description: "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world."
@@ -34,13 +34,13 @@ import type * as KardApi from "../../../../../index.js";
34
34
  * maxRedemptions: 1,
35
35
  * isTargeted: true,
36
36
  * assets: [{
37
- * type: "IMG_VIEW",
38
- * url: "http://assets.getkard.com/logo/img?attribution-tokens",
39
- * alt: "Worlds Greatest Chicken Logo Image"
37
+ * url: "http://attribution.getkard.com/logos/breakfastbunny_logo.png?subtype=IMG_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
38
+ * alt: "",
39
+ * type: "IMG_VIEW"
40
40
  * }, {
41
- * type: "BANNER_VIEW",
42
- * url: "http://assets.getkard.com/banner/img?attribution-tokens",
43
- * alt: "Worlds Greatest Chicken Banner Image"
41
+ * url: "https://attribution.getkard.com/public/banners/breakfast-bunny-banner.jpg?subtype=BANNER_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
42
+ * alt: "",
43
+ * type: "BANNER_VIEW"
44
44
  * }],
45
45
  * websiteUrl: "http://worldsgreatestchickent.test.com",
46
46
  * description: "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world."
@@ -11,6 +11,10 @@ export declare class UploadsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<UploadsClient.Options>;
12
12
  constructor(options?: UploadsClient.Options);
13
13
  /**
14
+ * @deprecated
15
+ *
16
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
17
+ *
14
18
  * Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
15
19
  * Part](/api/uploads/create-upload-part) endpoint, historical transactions can be sent in batches for further processing.
16
20
  * <b>Required scopes:</b> `transaction:write`
@@ -35,6 +39,10 @@ export declare class UploadsClient {
35
39
  create(organizationId: KardApi.OrganizationId, userId: string, request: KardApi.users.CreateUploadRequestObject, requestOptions?: UploadsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.CreateUploadResponseObject>;
36
40
  private __create;
37
41
  /**
42
+ * @deprecated
43
+ *
44
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
45
+ *
38
46
  * Call this endpoint using the upload ID provided in the [Create Upload](/api/uploads/create-upload) endpoint to add parts to your upload. Currently, this endpoint supports adding historical transactions.
39
47
  * <b>Required scopes:</b> `transaction:write`
40
48
  * <b>Note:</b> `Maximum of 500 transactions can be uploaded per request`.
@@ -93,6 +101,10 @@ export declare class UploadsClient {
93
101
  createPart(organizationId: KardApi.OrganizationId, userId: string, uploadId: string, request: KardApi.users.CreateUploadPartRequestObject, requestOptions?: UploadsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.CreateUploadPartResponseObject>;
94
102
  private __createPart;
95
103
  /**
104
+ * @deprecated
105
+ *
106
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
107
+ *
96
108
  * Call this endpoint to update your upload session. Currently, you can signal completing a historical transactions upload.
97
109
  * <b>Required scopes:</b> `transaction:write`
98
110
  *
@@ -56,6 +56,10 @@ class UploadsClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
+ * @deprecated
60
+ *
61
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
62
+ *
59
63
  * Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
60
64
  * Part](/api/uploads/create-upload-part) endpoint, historical transactions can be sent in batches for further processing.
61
65
  * <b>Required scopes:</b> `transaction:write`
@@ -125,6 +129,10 @@ class UploadsClient {
125
129
  });
126
130
  }
127
131
  /**
132
+ * @deprecated
133
+ *
134
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
135
+ *
128
136
  * Call this endpoint using the upload ID provided in the [Create Upload](/api/uploads/create-upload) endpoint to add parts to your upload. Currently, this endpoint supports adding historical transactions.
129
137
  * <b>Required scopes:</b> `transaction:write`
130
138
  * <b>Note:</b> `Maximum of 500 transactions can be uploaded per request`.
@@ -230,6 +238,10 @@ class UploadsClient {
230
238
  });
231
239
  }
232
240
  /**
241
+ * @deprecated
242
+ *
243
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
244
+ *
233
245
  * Call this endpoint to update your upload session. Currently, you can signal completing a historical transactions upload.
234
246
  * <b>Required scopes:</b> `transaction:write`
235
247
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "16.1.0";
1
+ export declare const SDK_VERSION = "16.1.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "16.1.0";
4
+ exports.SDK_VERSION = "16.1.2";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@kard-financial/sdk",
9
- "X-Fern-SDK-Version": "16.1.0",
10
- "User-Agent": "@kard-financial/sdk/16.1.0",
9
+ "X-Fern-SDK-Version": "16.1.2",
10
+ "User-Agent": "@kard-financial/sdk/16.1.2",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -238,7 +238,7 @@ export declare class TransactionsClient {
238
238
  * to storage. Each URL is valid for 15 minutes. Use the returned URL to upload the file via an HTTP PUT request with the
239
239
  * binary file content as the body. If a URL expires before the upload completes, you must request a new one.
240
240
  * Files can be uploaded as plain JSONL or as a gzip-compressed file.
241
- * Only `coreTransaction` type is supported for bulk file uploads.
241
+ * Supports both `incomingTransactionsFile` for daily transaction ingestion and `historicalTransactionsFile` for historical transaction ingestion. See the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide for details on the historical flow.
242
242
  * <b>Required scopes:</b> `transaction:write`
243
243
  *
244
244
  * @param {KardApi.OrganizationId} organizationId
@@ -264,6 +264,16 @@ export declare class TransactionsClient {
264
264
  * }
265
265
  * }]
266
266
  * })
267
+ *
268
+ * @example
269
+ * await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
270
+ * data: [{
271
+ * type: "historicalTransactionsFile",
272
+ * attributes: {
273
+ * filename: "historical_transactions_2024-10-15.jsonl"
274
+ * }
275
+ * }]
276
+ * })
267
277
  */
268
278
  createBulkTransactionsUploadUrl(organizationId: KardApi.OrganizationId, request: KardApi.CreateFileUploadRequestBody, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<KardApi.CreateFileUploadUrlResponse>;
269
279
  private __createBulkTransactionsUploadUrl;
@@ -385,7 +385,7 @@ export class TransactionsClient {
385
385
  * to storage. Each URL is valid for 15 minutes. Use the returned URL to upload the file via an HTTP PUT request with the
386
386
  * binary file content as the body. If a URL expires before the upload completes, you must request a new one.
387
387
  * Files can be uploaded as plain JSONL or as a gzip-compressed file.
388
- * Only `coreTransaction` type is supported for bulk file uploads.
388
+ * Supports both `incomingTransactionsFile` for daily transaction ingestion and `historicalTransactionsFile` for historical transaction ingestion. See the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide for details on the historical flow.
389
389
  * <b>Required scopes:</b> `transaction:write`
390
390
  *
391
391
  * @param {KardApi.OrganizationId} organizationId
@@ -411,6 +411,16 @@ export class TransactionsClient {
411
411
  * }
412
412
  * }]
413
413
  * })
414
+ *
415
+ * @example
416
+ * await client.transactions.createBulkTransactionsUploadUrl("organization-123", {
417
+ * data: [{
418
+ * type: "historicalTransactionsFile",
419
+ * attributes: {
420
+ * filename: "historical_transactions_2024-10-15.jsonl"
421
+ * }
422
+ * }]
423
+ * })
414
424
  */
415
425
  createBulkTransactionsUploadUrl(organizationId, request, requestOptions) {
416
426
  return core.HttpResponsePromise.fromPromise(this.__createBulkTransactionsUploadUrl(organizationId, request, requestOptions));
@@ -1,4 +1,4 @@
1
- /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for back-filled or retroactive transaction data that covers a past time period. */
1
+ /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for historical transaction ingestion. */
2
2
  export declare const FileUploadType: {
3
3
  readonly IncomingTransactionsFile: "incomingTransactionsFile";
4
4
  readonly HistoricalTransactionsFile: "historicalTransactionsFile";
@@ -1,5 +1,5 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for back-filled or retroactive transaction data that covers a past time period. */
2
+ /** Specifies the category of transaction file being uploaded. Use `incomingTransactionsFile` for new, real-time transactions that need to be processed and matched as they arrive. Use `historicalTransactionsFile` for historical transaction ingestion. */
3
3
  export const FileUploadType = {
4
4
  IncomingTransactionsFile: "incomingTransactionsFile",
5
5
  HistoricalTransactionsFile: "historicalTransactionsFile",
@@ -121,13 +121,13 @@ import type * as KardApi from "../../../../../index.mjs";
121
121
  * maxRedemptions: 1,
122
122
  * isTargeted: true,
123
123
  * assets: [{
124
- * type: "IMG_VIEW",
125
- * url: "http://assets.getkard.com/logo/img?attribution-tokens",
126
- * alt: "Worlds Greatest Chicken Logo Image"
124
+ * url: "http://attribution.getkard.com/logos/breakfastbunny_logo.png?subtype=IMG_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
125
+ * alt: "",
126
+ * type: "IMG_VIEW"
127
127
  * }, {
128
- * type: "BANNER_VIEW",
129
- * url: "http://assets.getkard.com/banner/img?attribution-tokens",
130
- * alt: "Worlds Greatest Chicken Banner Image"
128
+ * url: "https://attribution.getkard.com/public/banners/breakfast-bunny-banner.jpg?subtype=BANNER_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
129
+ * alt: "",
130
+ * type: "BANNER_VIEW"
131
131
  * }],
132
132
  * websiteUrl: "http://worldsgreatestchickent.test.com",
133
133
  * description: "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world."
@@ -34,13 +34,13 @@ import type * as KardApi from "../../../../../index.mjs";
34
34
  * maxRedemptions: 1,
35
35
  * isTargeted: true,
36
36
  * assets: [{
37
- * type: "IMG_VIEW",
38
- * url: "http://assets.getkard.com/logo/img?attribution-tokens",
39
- * alt: "Worlds Greatest Chicken Logo Image"
37
+ * url: "http://attribution.getkard.com/logos/breakfastbunny_logo.png?subtype=IMG_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
38
+ * alt: "",
39
+ * type: "IMG_VIEW"
40
40
  * }, {
41
- * type: "BANNER_VIEW",
42
- * url: "http://assets.getkard.com/banner/img?attribution-tokens",
43
- * alt: "Worlds Greatest Chicken Banner Image"
41
+ * url: "https://attribution.getkard.com/public/banners/breakfast-bunny-banner.jpg?subtype=BANNER_VIEW&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
42
+ * alt: "",
43
+ * type: "BANNER_VIEW"
44
44
  * }],
45
45
  * websiteUrl: "http://worldsgreatestchickent.test.com",
46
46
  * description: "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world."
@@ -11,6 +11,10 @@ export declare class UploadsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<UploadsClient.Options>;
12
12
  constructor(options?: UploadsClient.Options);
13
13
  /**
14
+ * @deprecated
15
+ *
16
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
17
+ *
14
18
  * Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
15
19
  * Part](/api/uploads/create-upload-part) endpoint, historical transactions can be sent in batches for further processing.
16
20
  * <b>Required scopes:</b> `transaction:write`
@@ -35,6 +39,10 @@ export declare class UploadsClient {
35
39
  create(organizationId: KardApi.OrganizationId, userId: string, request: KardApi.users.CreateUploadRequestObject, requestOptions?: UploadsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.CreateUploadResponseObject>;
36
40
  private __create;
37
41
  /**
42
+ * @deprecated
43
+ *
44
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
45
+ *
38
46
  * Call this endpoint using the upload ID provided in the [Create Upload](/api/uploads/create-upload) endpoint to add parts to your upload. Currently, this endpoint supports adding historical transactions.
39
47
  * <b>Required scopes:</b> `transaction:write`
40
48
  * <b>Note:</b> `Maximum of 500 transactions can be uploaded per request`.
@@ -93,6 +101,10 @@ export declare class UploadsClient {
93
101
  createPart(organizationId: KardApi.OrganizationId, userId: string, uploadId: string, request: KardApi.users.CreateUploadPartRequestObject, requestOptions?: UploadsClient.RequestOptions): core.HttpResponsePromise<KardApi.users.CreateUploadPartResponseObject>;
94
102
  private __createPart;
95
103
  /**
104
+ * @deprecated
105
+ *
106
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
107
+ *
96
108
  * Call this endpoint to update your upload session. Currently, you can signal completing a historical transactions upload.
97
109
  * <b>Required scopes:</b> `transaction:write`
98
110
  *
@@ -20,6 +20,10 @@ export class UploadsClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
+ * @deprecated
24
+ *
25
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
26
+ *
23
27
  * Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
24
28
  * Part](/api/uploads/create-upload-part) endpoint, historical transactions can be sent in batches for further processing.
25
29
  * <b>Required scopes:</b> `transaction:write`
@@ -89,6 +93,10 @@ export class UploadsClient {
89
93
  });
90
94
  }
91
95
  /**
96
+ * @deprecated
97
+ *
98
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
99
+ *
92
100
  * Call this endpoint using the upload ID provided in the [Create Upload](/api/uploads/create-upload) endpoint to add parts to your upload. Currently, this endpoint supports adding historical transactions.
93
101
  * <b>Required scopes:</b> `transaction:write`
94
102
  * <b>Note:</b> `Maximum of 500 transactions can be uploaded per request`.
@@ -194,6 +202,10 @@ export class UploadsClient {
194
202
  });
195
203
  }
196
204
  /**
205
+ * @deprecated
206
+ *
207
+ * <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
208
+ *
197
209
  * Call this endpoint to update your upload session. Currently, you can signal completing a historical transactions upload.
198
210
  * <b>Required scopes:</b> `transaction:write`
199
211
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "16.1.0";
1
+ export declare const SDK_VERSION = "16.1.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "16.1.0";
1
+ export const SDK_VERSION = "16.1.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kard-financial/sdk",
3
- "version": "16.1.0",
3
+ "version": "16.1.2",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -1556,7 +1556,7 @@ Generates up to 10 presigned PUT URLs for uploading JSONL transaction files (up
1556
1556
  to storage. Each URL is valid for 15 minutes. Use the returned URL to upload the file via an HTTP PUT request with the
1557
1557
  binary file content as the body. If a URL expires before the upload completes, you must request a new one.
1558
1558
  Files can be uploaded as plain JSONL or as a gzip-compressed file.
1559
- Only `coreTransaction` type is supported for bulk file uploads.
1559
+ Supports both `incomingTransactionsFile` for daily transaction ingestion and `historicalTransactionsFile` for historical transaction ingestion. See the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide for details on the historical flow.
1560
1560
  <b>Required scopes:</b> `transaction:write`
1561
1561
  </dd>
1562
1562
  </dl>
@@ -2679,7 +2679,9 @@ await client.users.rewards.locations("organization-123", "user-123", {
2679
2679
  <dl>
2680
2680
  <dd>
2681
2681
 
2682
- Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
2682
+ <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
2683
+
2684
+ Call this endpoint to create an upload session and retrieve an upload ID. Using the upload ID in the [Add Upload
2683
2685
  Part](/api/uploads/create-upload-part) endpoint, historical transactions can be sent in batches for further processing.
2684
2686
  <b>Required scopes:</b> `transaction:write`
2685
2687
  </dd>
@@ -2765,6 +2767,8 @@ await client.users.uploads.create("organization-123", "user-123", {
2765
2767
  <dl>
2766
2768
  <dd>
2767
2769
 
2770
+ <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
2771
+
2768
2772
  Call this endpoint using the upload ID provided in the [Create Upload](/api/uploads/create-upload) endpoint to add parts to your upload. Currently, this endpoint supports adding historical transactions.
2769
2773
  <b>Required scopes:</b> `transaction:write`
2770
2774
  <b>Note:</b> `Maximum of 500 transactions can be uploaded per request`.
@@ -2891,6 +2895,8 @@ await client.users.uploads.createPart("organization-123", "user-123", "upload-12
2891
2895
  <dl>
2892
2896
  <dd>
2893
2897
 
2898
+ <b>Deprecated.</b> This endpoint is deprecated in favor of the [Create Bulk Transactions Upload URL](/2024-10-01/api/transactions/create-bulk-transactions-upload-url) endpoint. New integrations should use the bulk flow outlined in the [Historical Transaction Uploads](/2024-10-01/api/integration-guides/historical-transaction-uploads) integration guide.
2899
+
2894
2900
  Call this endpoint to update your upload session. Currently, you can signal completing a historical transactions upload.
2895
2901
  <b>Required scopes:</b> `transaction:write`
2896
2902
  </dd>