zavudev 0.7.0 → 0.8.0

data/lib/zavudev/models/sub_account_get_balance_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#get_balance
+    class SubAccountGetBalanceParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_get_balance_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#get_balance
+    class SubAccountGetBalanceResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute balance
+      #   Team balance in cents. All charges are billed to the parent team.
+      #
+      #   @return [Integer]
+      required :balance, Integer
+
+      # @!attribute currency
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute credit_limit
+      #   Spending cap in cents (only for sub-accounts).
+      #
+      #   @return [Integer, nil]
+      optional :credit_limit, Integer, api_name: :creditLimit, nil?: true
+
+      # @!attribute is_sub_account
+      #   Whether this API key belongs to a sub-account.
+      #
+      #   @return [Boolean, nil]
+      optional :is_sub_account, Zavudev::Internal::Type::Boolean, api_name: :isSubAccount
+
+      # @!attribute total_spent
+      #   Total amount spent by this sub-account in cents (only for sub-accounts).
+      #
+      #   @return [Integer, nil]
+      optional :total_spent, Integer, api_name: :totalSpent, nil?: true
+
+      # @!method initialize(balance:, currency:, credit_limit: nil, is_sub_account: nil, total_spent: nil)
+      #   @param balance [Integer] Team balance in cents. All charges are billed to the parent team.
+      #
+      #   @param currency [String]
+      #
+      #   @param credit_limit [Integer, nil] Spending cap in cents (only for sub-accounts).
+      #
+      #   @param is_sub_account [Boolean] Whether this API key belongs to a sub-account.
+      #
+      #   @param total_spent [Integer, nil] Total amount spent by this sub-account in cents (only for sub-accounts).
+    end
+  end
+end

data/lib/zavudev/models/sub_account_list_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#list
+    class SubAccountListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   @param cursor [String]
+      #   @param limit [Integer]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#retrieve
+    class SubAccountRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#retrieve
+    class SubAccountRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute sub_account
+      #
+      #   @return [Zavudev::Models::SubAccount]
+      required :sub_account, -> { Zavudev::SubAccount }, api_name: :subAccount
+
+      # @!method initialize(sub_account:)
+      #   @param sub_account [Zavudev::Models::SubAccount]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_update_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#update
+    class SubAccountUpdateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute credit_limit
+      #
+      #   @return [Integer, nil]
+      optional :credit_limit, Integer, api_name: :creditLimit, nil?: true
+
+      # @!attribute external_id
+      #
+      #   @return [String, nil]
+      optional :external_id, String, api_name: :externalId
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[Zavudev::Internal::Type::Unknown]
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::SubAccountUpdateParams::Status, nil]
+      optional :status, enum: -> { Zavudev::SubAccountUpdateParams::Status }
+
+      # @!method initialize(id:, credit_limit: nil, external_id: nil, metadata: nil, name: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #   @param credit_limit [Integer, nil]
+      #   @param external_id [String]
+      #   @param metadata [Hash{Symbol=>Object}]
+      #   @param name [String]
+      #   @param status [Symbol, Zavudev::Models::SubAccountUpdateParams::Status]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_account_update_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#update
+    class SubAccountUpdateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute sub_account
+      #
+      #   @return [Zavudev::Models::SubAccount]
+      required :sub_account, -> { Zavudev::SubAccount }, api_name: :subAccount
+
+      # @!method initialize(sub_account:)
+      #   @param sub_account [Zavudev::Models::SubAccount]
+    end
+  end
+end

data/lib/zavudev/models/sub_accounts/api_key_create_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module SubAccounts
+      # @see Zavudev::Resources::SubAccounts::APIKeys#create
+      class APIKeyCreateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute environment
+        #
+        #   @return [Symbol, Zavudev::Models::SubAccounts::APIKeyCreateParams::Environment, nil]
+        optional :environment, enum: -> { Zavudev::SubAccounts::APIKeyCreateParams::Environment }
+
+        # @!attribute permissions
+        #
+        #   @return [Array<String>, nil]
+        optional :permissions, Zavudev::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, name:, environment: nil, permissions: nil, request_options: {})
+        #   @param id [String]
+        #   @param name [String]
+        #   @param environment [Symbol, Zavudev::Models::SubAccounts::APIKeyCreateParams::Environment]
+        #   @param permissions [Array<String>]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+        module Environment
+          extend Zavudev::Internal::Type::Enum
+
+          LIVE = :live
+          TEST = :test
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_accounts/api_key_create_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module SubAccounts
+      # @see Zavudev::Resources::SubAccounts::APIKeys#create
+      class APIKeyCreateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute api_key
+        #
+        #   @return [Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey]
+        required :api_key, -> { Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey }, api_name: :apiKey
+
+        # @!method initialize(api_key:)
+        #   @param api_key [Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey]
+
+        # @see Zavudev::Models::SubAccounts::APIKeyCreateResponse#api_key
+        class APIKey < Zavudev::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute environment
+          #
+          #   @return [Symbol, Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey::Environment]
+          required :environment,
+                   enum: -> { Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey::Environment }
+
+          # @!attribute key
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(id:, environment:, key:, name:)
+          #   @param id [String]
+          #   @param environment [Symbol, Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey::Environment]
+          #   @param key [String]
+          #   @param name [String]
+
+          # @see Zavudev::Models::SubAccounts::APIKeyCreateResponse::APIKey#environment
+          module Environment
+            extend Zavudev::Internal::Type::Enum
+
+            LIVE = :live
+            TEST = :test
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_accounts/api_key_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module SubAccounts
+      # @see Zavudev::Resources::SubAccounts::APIKeys#list
+      class APIKeyListParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_accounts/api_key_list_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module SubAccounts
+      # @see Zavudev::Resources::SubAccounts::APIKeys#list
+      class APIKeyListResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Zavudev::Models::SubAccounts::APIKeyListResponse::Item>]
+        required :items,
+                 -> { Zavudev::Internal::Type::ArrayOf[Zavudev::Models::SubAccounts::APIKeyListResponse::Item] }
+
+        # @!method initialize(items:)
+        #   @param items [Array<Zavudev::Models::SubAccounts::APIKeyListResponse::Item>]
+
+        class Item < Zavudev::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Float]
+          required :created_at, Float, api_name: :createdAt
+
+          # @!attribute environment
+          #
+          #   @return [Symbol, Zavudev::Models::SubAccounts::APIKeyListResponse::Item::Environment]
+          required :environment, enum: -> { Zavudev::Models::SubAccounts::APIKeyListResponse::Item::Environment }
+
+          # @!attribute key_prefix
+          #   First characters of the key for identification.
+          #
+          #   @return [String]
+          required :key_prefix, String, api_name: :keyPrefix
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute key
+          #   Full API key. Only returned on creation.
+          #
+          #   @return [String, nil]
+          optional :key, String
+
+          # @!attribute last_used_at
+          #
+          #   @return [Float, nil]
+          optional :last_used_at, Float, api_name: :lastUsedAt, nil?: true
+
+          # @!attribute permissions
+          #
+          #   @return [Array<String>, nil]
+          optional :permissions, Zavudev::Internal::Type::ArrayOf[String]
+
+          # @!attribute revoked_at
+          #
+          #   @return [Float, nil]
+          optional :revoked_at, Float, api_name: :revokedAt, nil?: true
+
+          # @!method initialize(id:, created_at:, environment:, key_prefix:, name:, key: nil, last_used_at: nil, permissions: nil, revoked_at: nil)
+          #   @param id [String]
+          #
+          #   @param created_at [Float]
+          #
+          #   @param environment [Symbol, Zavudev::Models::SubAccounts::APIKeyListResponse::Item::Environment]
+          #
+          #   @param key_prefix [String] First characters of the key for identification.
+          #
+          #   @param name [String]
+          #
+          #   @param key [String] Full API key. Only returned on creation.
+          #
+          #   @param last_used_at [Float, nil]
+          #
+          #   @param permissions [Array<String>]
+          #
+          #   @param revoked_at [Float, nil]
+
+          # @see Zavudev::Models::SubAccounts::APIKeyListResponse::Item#environment
+          module Environment
+            extend Zavudev::Internal::Type::Enum
+
+            LIVE = :live
+            TEST = :test
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_accounts/api_key_revoke_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module SubAccounts
+      # @see Zavudev::Resources::SubAccounts::APIKeys#revoke
+      class APIKeyRevokeParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute key_id
+        #
+        #   @return [String]
+        required :key_id, String
+
+        # @!method initialize(id:, key_id:, request_options: {})
+        #   @param id [String]
+        #   @param key_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/zavudev/models/template.rb

@@ -160,6 +160,13 @@ module Zavudev
       #   @param whatsapp [Zavudev::Models::Template::Whatsapp] WhatsApp-specific template information.
 
       class Button < Zavudev::Internal::Type::BaseModel
+        # @!attribute example
+        #   Sample value used to substitute `{{1}}` in the URL when submitting the template
+        #   to Meta for review. Only present for dynamic URL buttons.
+        #
+        #   @return [String, nil]
+        optional :example, String
+
         # @!attribute otp_type
         #   OTP button type. Required when type is 'otp'.
         #
@@ -198,7 +205,12 @@ module Zavudev
         #   @return [String, nil]
         optional :url, String
 
-        # @!method initialize(otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, text: nil, type: nil, url: nil)
+        # @!method initialize(example: nil, otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, text: nil, type: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Zavudev::Models::Template::Button} for more details.
+        #
+        #   @param example [String] Sample value used to substitute `{{1}}` in the URL when submitting the template
+        #
         #   @param otp_type [Symbol, Zavudev::Models::Template::Button::OtpType] OTP button type. Required when type is 'otp'.
         #
         #   @param package_name [String] Android package name. Required for ONE_TAP buttons.

data/lib/zavudev/models/template_create_params.rb

@@ -132,6 +132,14 @@ module Zavudev
         #   @return [Symbol, Zavudev::Models::TemplateCreateParams::Button::Type]
         required :type, enum: -> { Zavudev::TemplateCreateParams::Button::Type }
 
+        # @!attribute example
+        #   Sample value Meta uses to review templates with a dynamic URL button.
+        #   Substituted into `{{1}}` of the URL when the template is submitted to Meta. Only
+        #   meaningful when `url` contains `{{1}}`; ignored for static URLs.
+        #
+        #   @return [String, nil]
+        optional :example, String
+
         # @!attribute otp_type
         #   Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
         #   Android autofill.
@@ -157,11 +165,14 @@ module Zavudev
         optional :signature_hash, String, api_name: :signatureHash
 
         # @!attribute url
+        #   Button destination. Use `{{1}}` exactly once for a dynamic URL (e.g.
+        #   `https://example.com/orders/{{1}}`); WhatsApp only accepts the strict `{{1}}`
+        #   form. Static URLs must not contain any `{{...}}` placeholder.
         #
         #   @return [String, nil]
         optional :url, String
 
-        # @!method initialize(text:, type:, otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, url: nil)
+        # @!method initialize(text:, type:, example: nil, otp_type: nil, package_name: nil, phone_number: nil, signature_hash: nil, url: nil)
         #   Some parameter documentations has been truncated, see
         #   {Zavudev::Models::TemplateCreateParams::Button} for more details.
         #
@@ -169,6 +180,8 @@ module Zavudev
         #
         #   @param type [Symbol, Zavudev::Models::TemplateCreateParams::Button::Type]
         #
+        #   @param example [String] Sample value Meta uses to review templates with a dynamic URL button. Substitute
+        #
         #   @param otp_type [Symbol, Zavudev::Models::TemplateCreateParams::Button::OtpType] Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables Androi
         #
         #   @param package_name [String] Android package name. Required for ONE_TAP buttons.
@@ -177,7 +190,7 @@ module Zavudev
         #
         #   @param signature_hash [String] Android app signature hash. Required for ONE_TAP buttons.
         #
-        #   @param url [String]
+        #   @param url [String] Button destination. Use `{{1}}` exactly once for a dynamic URL (e.g. `https://ex
 
         # @see Zavudev::Models::TemplateCreateParams::Button#type
         module Type

data/lib/zavudev/models/url_list_verified_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#list_verified
+    class URLListVerifiedParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Filter by verification status.
+      #
+      #   @return [Symbol, Zavudev::Models::URLListVerifiedParams::Status, nil]
+      optional :status, enum: -> { Zavudev::URLListVerifiedParams::Status }
+
+      # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
+      #   @param cursor [String]
+      #
+      #   @param limit [Integer]
+      #
+      #   @param status [Symbol, Zavudev::Models::URLListVerifiedParams::Status] Filter by verification status.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by verification status.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        PENDING = :pending
+        APPROVED = :approved
+        REJECTED = :rejected
+        MALICIOUS = :malicious
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/url_retrieve_details_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#retrieve_details
+    class URLRetrieveDetailsParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute url_id
+      #
+      #   @return [String]
+      required :url_id, String
+
+      # @!method initialize(url_id:, request_options: {})
+      #   @param url_id [String]
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/url_retrieve_details_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#retrieve_details
+    class URLRetrieveDetailsResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute url
+      #
+      #   @return [Zavudev::Models::VerifiedURL]
+      required :url, -> { Zavudev::VerifiedURL }
+
+      # @!method initialize(url:)
+      #   @param url [Zavudev::Models::VerifiedURL]
+    end
+  end
+end

data/lib/zavudev/models/url_submit_for_verification_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#submit_for_verification
+    class URLSubmitForVerificationParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   The URL to submit for verification.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(url:, request_options: {})
+      #   @param url [String] The URL to submit for verification.
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/url_submit_for_verification_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::URLs#submit_for_verification
+    class URLSubmitForVerificationResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute url
+      #
+      #   @return [Zavudev::Models::VerifiedURL]
+      required :url, -> { Zavudev::VerifiedURL }
+
+      # @!method initialize(url:)
+      #   @param url [Zavudev::Models::VerifiedURL]
+    end
+  end
+end