@snagsolutions/sdk 0.1.0-alpha.55 → 0.1.0-alpha.57

package/src/resources/loyalty/questions-responses.ts

@@ -8,6 +8,12 @@ export class QuestionsResponses extends APIResource {
   /**
    * Retrieve responses submitted by the authenticated user, optionally filtered by
    * question IDs
+   *
+   * @example
+   * ```ts
+   * const questionsResponses =
+   *   await client.loyalty.questionsResponses.list();
+   * ```
    */
   list(
     query?: QuestionsResponseListParams,
@@ -26,6 +32,15 @@ export class QuestionsResponses extends APIResource {
 
   /**
    * This endpoint allows you to submit a response to a question.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.questionsResponses.submit({
+   *     loyaltyQuestionChoiceId:
+   *       '123e4567-e89b-12d3-a456-426614174001',
+   *   });
+   * ```
    */
   submit(
     body: QuestionsResponseSubmitParams,

package/src/resources/loyalty/questions.ts

@@ -6,6 +6,17 @@ import * as Core from '../../core';
 export class Questions extends APIResource {
   /**
    * This endpoint allows you to create a new question.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.create({
+   *   loyaltyQuestionAnswers: [
+   *     { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *   ],
+   *   loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174000',
+   *   questionText: 'What is your favorite color?',
+   * });
+   * ```
    */
   create(body: QuestionCreateParams, options?: Core.RequestOptions): Core.APIPromise<QuestionCreateResponse> {
     return this._client.post('/api/loyalty/questions', { body, ...options });
@@ -13,6 +24,19 @@ export class Questions extends APIResource {
 
   /**
    * This endpoint allows you to update an existing question.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.update(
+   *   'id',
+   *   {
+   *     loyaltyQuestionAnswers: [
+   *       { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *     ],
+   *     questionText: 'What is your favorite color?',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -24,6 +48,15 @@ export class Questions extends APIResource {
 
   /**
    * This endpoint allows you to fetch questions for a loyalty rule.
+   *
+   * @example
+   * ```ts
+   * const questions = await client.loyalty.questions.list({
+   *   loyaltyRuleIds: '123e4567-e89b-12d3-a456-426614174000',
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174002',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174001',
+   * });
+   * ```
    */
   list(query: QuestionListParams, options?: Core.RequestOptions): Core.APIPromise<QuestionListResponse> {
     return this._client.get('/api/loyalty/questions', { query, ...options });

package/src/resources/loyalty/rule-edits.ts

@@ -6,6 +6,13 @@ import * as Core from '../../core';
 export class RuleEdits extends APIResource {
   /**
    * Retrieve configured loyalty rule edits with optional pagination and filters
+   *
+   * @example
+   * ```ts
+   * const ruleEdits = await client.loyalty.ruleEdits.list({
+   *   loyaltyRuleId: true,
+   * });
+   * ```
    */
   list(query: RuleEditListParams, options?: Core.RequestOptions): Core.APIPromise<RuleEditListResponse> {
     return this._client.get('/api/loyalty/rule_edits', { query, ...options });
@@ -13,6 +20,13 @@ export class RuleEdits extends APIResource {
 
   /**
    * Restore a loyalty rule from a rule edit
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.ruleEdits.restore(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   restore(
     id: string,
@@ -577,6 +591,7 @@ export namespace RuleEditListResponse {
             | 'skaleNebula'
             | 'solana'
             | 'sophon'
+            | 'sophonTestnet'
             | 'sui'
             | 'superseed'
             | 'superseedSepolia'
@@ -701,6 +716,7 @@ export namespace RuleEditListResponse {
             | 'skaleNebula'
             | 'solana'
             | 'sophon'
+            | 'sophonTestnet'
             | 'sui'
             | 'superseed'
             | 'superseedSepolia'
@@ -1444,6 +1460,7 @@ export namespace RuleEditListResponse {
             | 'skaleNebula'
             | 'solana'
             | 'sophon'
+            | 'sophonTestnet'
             | 'sui'
             | 'superseed'
             | 'superseedSepolia'
@@ -1568,6 +1585,7 @@ export namespace RuleEditListResponse {
             | 'skaleNebula'
             | 'solana'
             | 'sophon'
+            | 'sophonTestnet'
             | 'sui'
             | 'superseed'
             | 'superseedSepolia'
@@ -2366,6 +2384,7 @@ export namespace RuleEditRestoreResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'
@@ -2490,6 +2509,7 @@ export namespace RuleEditRestoreResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'
@@ -3233,6 +3253,7 @@ export namespace RuleEditRestoreResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'
@@ -3357,6 +3378,7 @@ export namespace RuleEditRestoreResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'

package/src/resources/loyalty/rule-groups.ts

@@ -7,6 +7,16 @@ import * as Core from '../../core';
 export class RuleGroups extends APIResource {
   /**
    * Create a new loyalty rule groups
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.ruleGroups.createRuleGroup({
+   *     name: 'name',
+   *     organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   });
+   * ```
    */
   createRuleGroup(
     body: RuleGroupCreateRuleGroupParams,
@@ -17,6 +27,14 @@ export class RuleGroups extends APIResource {
 
   /**
    * Delete loyalty rule group by ID
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.ruleGroups.deleteRuleGroup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   deleteRuleGroup(id: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
     return this._client.delete(`/api/loyalty/rule_groups/${id}`, options);
@@ -24,6 +42,12 @@ export class RuleGroups extends APIResource {
 
   /**
    * Retrieve configured loyalty rule groups
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.ruleGroups.getRuleGroups();
+   * ```
    */
   getRuleGroups(
     query?: RuleGroupGetRuleGroupsParams,
@@ -42,6 +66,14 @@ export class RuleGroups extends APIResource {
 
   /**
    * Update loyalty rule group by ID
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.ruleGroups.updateRuleGroup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   updateRuleGroup(
     id: string,
@@ -212,6 +244,7 @@ export namespace RuleGroupGetRuleGroupsResponse {
           | 'steam_wishlist'
           | 'liquidity_uniswap_v2'
           | 'liquidity_uniswap_v3'
+          | 'points_airdrop'
           | 'youtube_subscribers'
           | 'youtube_comment';
       }
@@ -630,6 +663,7 @@ export namespace RuleGroupGetRuleGroupsResponse {
               | 'skaleNebula'
               | 'solana'
               | 'sophon'
+              | 'sophonTestnet'
               | 'sui'
               | 'superseed'
               | 'superseedSepolia'
@@ -754,6 +788,7 @@ export namespace RuleGroupGetRuleGroupsResponse {
               | 'skaleNebula'
               | 'solana'
               | 'sophon'
+              | 'sophonTestnet'
               | 'sui'
               | 'superseed'
               | 'superseedSepolia'

package/src/resources/loyalty/rules.ts

@@ -7,6 +7,24 @@ import * as Core from '../../core';
 export class Rules extends APIResource {
   /**
    * Create a new Loyalty Rule
+   *
+   * @example
+   * ```ts
+   * const rule = await client.loyalty.rules.create({
+   *   amount: '10.5',
+   *   effectiveEndTime: '2024-12-31T23:59:00Z',
+   *   effectiveStartTime: '2024-01-01T00:00:00Z',
+   *   endTime: '2024-12-31T23:59:00Z',
+   *   frequency: 'daily',
+   *   loyaltyCurrencyId: '456e1234-e89b-12d3-a456-426614174003',
+   *   metadata: {},
+   *   name: 'Referral Bonus Rule',
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *   startTime: '2024-01-01T00:00:00Z',
+   *   type: 'Bonus',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174002',
+   * });
+   * ```
    */
   create(body: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse> {
     return this._client.post('/api/loyalty/rules', { body, ...options });
@@ -14,6 +32,18 @@ export class Rules extends APIResource {
 
   /**
    * Update an existing Loyalty Rule
+   *
+   * @example
+   * ```ts
+   * const rule = await client.loyalty.rules.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     amount: '10.5',
+   *     endTime: '2024-12-31T23:59:00Z',
+   *     name: 'Daily Rewards Program',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -25,6 +55,11 @@ export class Rules extends APIResource {
 
   /**
    * Retrieve configured loyalty rules with optional pagination and filters
+   *
+   * @example
+   * ```ts
+   * const rules = await client.loyalty.rules.list();
+   * ```
    */
   list(query?: RuleListParams, options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
@@ -40,6 +75,13 @@ export class Rules extends APIResource {
 
   /**
    * Delete an existing Loyalty Rule
+   *
+   * @example
+   * ```ts
+   * const rule = await client.loyalty.rules.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(
     id: string,
@@ -64,7 +106,15 @@ export class Rules extends APIResource {
    * endpoint currently only supports following rule types code_entry, text_input,
    * link_click, discord_member, connect_wallet, check_in, external_rule,
    * drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name,
-   * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages
+   * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages,
+   * youtube_subscribers, youtube_comment, steam_wishlist
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.rules.complete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   complete(
     id: string,
@@ -85,6 +135,11 @@ export class Rules extends APIResource {
 
   /**
    * This will return the processing status of quests for a specific user
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.rules.getStatus();
+   * ```
    */
   getStatus(
     query?: RuleGetStatusParams,
@@ -215,6 +270,7 @@ export interface RuleCreateResponse {
     | 'steam_wishlist'
     | 'liquidity_uniswap_v2'
     | 'liquidity_uniswap_v3'
+    | 'points_airdrop'
     | 'youtube_subscribers'
     | 'youtube_comment';
 
@@ -309,6 +365,7 @@ export interface RuleCreateResponse {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
@@ -746,6 +803,7 @@ export namespace RuleCreateResponse {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -870,6 +928,7 @@ export namespace RuleCreateResponse {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -1150,6 +1209,7 @@ export namespace RuleCreateResponse {
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
@@ -1280,6 +1340,7 @@ export interface RuleUpdateResponse {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
@@ -1348,6 +1409,7 @@ export namespace RuleUpdateResponse {
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
@@ -1769,6 +1831,7 @@ export namespace RuleUpdateResponse {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -1893,6 +1956,7 @@ export namespace RuleUpdateResponse {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -2745,6 +2809,7 @@ export namespace RuleListResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'
@@ -2869,6 +2934,7 @@ export namespace RuleListResponse {
           | 'skaleNebula'
           | 'solana'
           | 'sophon'
+          | 'sophonTestnet'
           | 'sui'
           | 'superseed'
           | 'superseedSepolia'
@@ -3258,6 +3324,7 @@ export interface RuleCreateParams {
     | 'steam_wishlist'
     | 'liquidity_uniswap_v2'
     | 'liquidity_uniswap_v3'
+    | 'points_airdrop'
     | 'youtube_subscribers'
     | 'youtube_comment';
 
@@ -3352,6 +3419,7 @@ export interface RuleCreateParams {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
@@ -3789,6 +3857,7 @@ export namespace RuleCreateParams {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -3913,6 +3982,7 @@ export namespace RuleCreateParams {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -4193,6 +4263,7 @@ export namespace RuleCreateParams {
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
@@ -4321,6 +4392,7 @@ export interface RuleUpdateParams {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
@@ -4389,6 +4461,7 @@ export namespace RuleUpdateParams {
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
@@ -4810,6 +4883,7 @@ export namespace RuleUpdateParams {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
@@ -4934,6 +5008,7 @@ export namespace RuleUpdateParams {
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'

package/src/resources/loyalty/transactions/rule-statuses.ts

@@ -7,6 +7,14 @@ import * as Core from '../../../core';
 export class RuleStatuses extends APIResource {
   /**
    * Update a loyalty rule status
+   *
+   * @example
+   * ```ts
+   * const ruleStatus =
+   *   await client.loyalty.transactions.ruleStatuses.update({
+   *     loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174030',
+   *   });
+   * ```
    */
   update(
     body: RuleStatusUpdateParams,
@@ -17,6 +25,12 @@ export class RuleStatuses extends APIResource {
 
   /**
    * Retrieve loyalty rule statuses
+   *
+   * @example
+   * ```ts
+   * const ruleStatuses =
+   *   await client.loyalty.transactions.ruleStatuses.list();
+   * ```
    */
   list(query?: RuleStatusListParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<RuleStatusListResponse>;

package/src/resources/loyalty/transactions/transactions.ts

@@ -17,6 +17,15 @@ export class Transactions extends APIResource {
 
   /**
    * Create a loyalty transaction to update account balances.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.transactions.createTransaction({
+   *     description: 'Purchase of item X',
+   *     entries: [{ amount: 5 }],
+   *   });
+   * ```
    */
   createTransaction(
     body: TransactionCreateTransactionParams,
@@ -28,6 +37,12 @@ export class Transactions extends APIResource {
   /**
    * Fetch loyalty transaction entries for wallets or users, representing account
    * balance changes.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.transactions.getTransactionEntries();
+   * ```
    */
   getTransactionEntries(
     query?: TransactionGetTransactionEntriesParams,
@@ -48,6 +63,15 @@ export class Transactions extends APIResource {
 
   /**
    * Retrieve configured loyalty rule chains
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.transactions.listRuleChains({
+   *     organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *     websiteId: '123e4567-e89b-12d3-a456-426614174002',
+   *   });
+   * ```
    */
   listRuleChains(
     query: TransactionListRuleChainsParams,
@@ -386,6 +410,8 @@ export interface TransactionGetTransactionEntriesParams {
    */
   direction?: 'credit' | 'debit';
 
+  excludeDeletedCurrency?: 'true' | 'false';
+
   /**
    * Key to ensure idempotency of the request
    */
@@ -463,6 +489,7 @@ export interface TransactionGetTransactionEntriesParams {
     | 'steam_wishlist'
     | 'liquidity_uniswap_v2'
     | 'liquidity_uniswap_v3'
+    | 'points_airdrop'
     | 'youtube_subscribers'
     | 'youtube_comment'
     | Array<
@@ -522,6 +549,7 @@ export interface TransactionGetTransactionEntriesParams {
         | 'steam_wishlist'
         | 'liquidity_uniswap_v2'
         | 'liquidity_uniswap_v3'
+        | 'points_airdrop'
         | 'youtube_subscribers'
         | 'youtube_comment'
       >;

package/src/resources/minting.ts

@@ -111,6 +111,7 @@ export interface MintingGetAssetsParams {
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'

package/src/resources/referral/referral.ts

@@ -10,6 +10,13 @@ export class Referral extends APIResource {
 
   /**
    * This endpoint allows you to create a referral code
+   *
+   * @example
+   * ```ts
+   * const response = await client.referral.createCode({
+   *   loyaltyRuleId: '558bcf56-24f1-4ef4-9787-043086295780',
+   * });
+   * ```
    */
   createCode(
     body: ReferralCreateCodeParams,

package/src/resources/referral/users.ts

@@ -6,6 +6,13 @@ import * as Core from '../../core';
 export class Users extends APIResource {
   /**
    * This endpoint allows you to create a referral user
+   *
+   * @example
+   * ```ts
+   * const user = await client.referral.users.create({
+   *   userIds: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
+   * });
+   * ```
    */
   create(body: UserCreateParams, options?: Core.RequestOptions): Core.APIPromise<UserCreateResponse> {
     return this._client.post('/api/referral/users', { body, ...options });
@@ -13,6 +20,13 @@ export class Users extends APIResource {
 
   /**
    * This endpoint allows you to get referrals
+   *
+   * @example
+   * ```ts
+   * const users = await client.referral.users.list({
+   *   walletAddress: 'string',
+   * });
+   * ```
    */
   list(query: UserListParams, options?: Core.RequestOptions): Core.APIPromise<UserListResponse> {
     return this._client.get('/api/referral/users', { query, ...options });

package/src/resources/users/metadatas.ts

@@ -7,6 +7,11 @@ import * as Core from '../../core';
 export class Metadatas extends APIResource {
   /**
    * This endpoint is used to create user metadata
+   *
+   * @example
+   * ```ts
+   * const metadata = await client.users.metadatas.create();
+   * ```
    */
   create(body?: MetadataCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
   create(options?: Core.RequestOptions): Core.APIPromise<MetadataCreateResponse>;
@@ -22,6 +27,11 @@ export class Metadatas extends APIResource {
 
   /**
    * This endpoint is used to get user metadata
+   *
+   * @example
+   * ```ts
+   * const metadatas = await client.users.metadatas.list();
+   * ```
    */
   list(query?: MetadataListParams, options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<MetadataListResponse>;