starkinfra 0.5.2 → 0.7.0

data/lib/individual_account_request/log.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('individual_account_request')
+
+module StarkInfra
+  class IndividualAccountRequest
+    # # IndividualAccountRequest::Log object
+    #
+    # Every time an IndividualAccountRequest entity is modified, a corresponding IndividualAccountRequest::Log
+    # is generated for the entity. This Log is never generated by the user, but it can be retrieved to check
+    # additional information on the IndividualAccountRequest.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - request [IndividualAccountRequest]: IndividualAccountRequest entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this IndividualAccountRequest event.
+    # - type [string]: type of the IndividualAccountRequest event which triggered the log creation. Options: 'approved', 'created', 'denied', 'processing', 'updated'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :request, :errors, :type, :created
+      def initialize(id: nil, request: nil, errors: nil, type: nil, created: nil)
+        super(id)
+        @request = request
+        @errors = errors
+        @type = type
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific IndividualAccountRequest::Log
+      #
+      # Receive a single IndividualAccountRequest::Log object previously created by the Stark Infra API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - IndividualAccountRequest::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve IndividualAccountRequest::Logs
+      #
+      # Receive a generator of IndividualAccountRequest::Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter for log event types. Options: 'approved', 'created', 'denied', 'processing', 'updated'
+      # - account_request_ids [list of strings, default nil]: list of IndividualAccountRequest ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of IndividualAccountRequest::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, account_request_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          account_request_ids: account_request_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged IndividualAccountRequest::Logs
+      #
+      # Receive a list of up to 100 IndividualAccountRequest::Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your requests.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter for log event types. Options: 'approved', 'created', 'denied', 'processing', 'updated'
+      # - account_request_ids [list of strings, default nil]: list of IndividualAccountRequest ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of IndividualAccountRequest::Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, account_request_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          account_request_ids: account_request_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::IndividualAccountRequest.resource[:resource_maker]
+        {
+          resource_name: 'IndividualAccountRequestLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              request: StarkCore::Utils::API.from_api_json(request_maker, json['request']),
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/individual_identity/individual_identity.rb

@@ -7,11 +7,8 @@ require_relative('../utils/parse')
 module StarkInfra
   # # IndividualIdentity object
   #
-  # An IndividualDocument represents an individual to be validated. It can have several individual documents attached
-  # to it, which are used to validate the identity of the individual. Once an individual identity is created, individual
-  # documents must be attached to it using the created method of the individual document resource. When all the required
-  # individual documents are attached to an individual identity it can be sent to validation by patching its status to 
-  # processing.
+  # An IndividualIdentity represents an individual to be validated. Once an individual identity is created,
+  # it can be sent to validation by patching its status to processing.
   #
   # When you initialize a IndividualIdentity, the entity will not be automatically
   # created in the Stark Infra API. The 'create' function sends the objects
@@ -26,7 +23,7 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the IndividualIdentity is created. ex: "5656565656565656"
-  # - status [string]: current status of the IndividualIdentity. Options: "created", "canceled", "processing", "failed", "success"
+  # - status [string]: current status of the IndividualIdentity. Options: "created", "processing", "pending", "success", "failed" — there is no "canceled" value; canceling an identity moves it to "failed".
   # - created [DateTime]: creation datetime for the IndividualIdentity. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IndividualIdentity < StarkCore::Utils::Resource
     attr_reader :name, :tax_id, :tags, :id, :status, :created
@@ -141,7 +138,7 @@ module StarkInfra
     #
     # ## Parameters (required):
     # - id [string]: IndividualIdentity unique id. ex: '5656565656565656'
-    # - status [string]: You may send IndividualDocuments to validation by passing 'processing' in the status
+    # - status [string]: You may send an IndividualIdentity to validation by passing 'processing' in the status
     #
     # ## Parameters (optional):
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call

data/lib/issuing_balance/issuing_balance.rb

@@ -13,13 +13,17 @@ module StarkInfra
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingBalance is created. ex: '5656565656565656'
   # - amount [integer]: current issuing balance amount of the Workspace in cents. ex: 200 (= R$ 2.00)
+  # - limit [integer]: Spending limit of the balance
+  # - max_limit [integer]: Maximum spending limit. This field is currently always equal to limit
   # - currency [string]: currency of the current Workspace. Expect others to be added eventually. ex: 'BRL'
   # - updated [DateTime]: latest update datetime for the IssuingBalance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingBalance < StarkCore::Utils::Resource
-    attr_reader :amount, :currency, :updated, :id
-    def initialize(amount: nil, currency: nil, updated: nil, id: nil)
+    attr_reader :amount, :limit, :max_limit, :currency, :updated, :id
+    def initialize(amount: nil, limit: nil, max_limit: nil, currency: nil, updated: nil, id: nil)
       super(id)
       @amount = amount
+      @limit = limit
+      @max_limit = max_limit
       @currency = currency
       @updated = updated
     end
@@ -44,6 +48,8 @@ module StarkInfra
           IssuingBalance.new(
             id: json['id'],
             amount: json['amount'],
+            limit: json['limit'],
+            max_limit: json['max_limit'],
             currency: json['currency'],
             updated: json['updated']
           )

data/lib/issuing_billing_invoice/issuing_billing_invoice.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # IssuingBillingInvoice object
+  #
+  # The IssuingBillingInvoice objects created in your Workspace report the
+  # billing cycle charges of your Issuing operation.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingBillingInvoice is created. ex: '5656565656565656'
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  # - fine [float]: Fine percentage applied when paid after the due date. ex: 2.0
+  # - interest [float]: Monthly interest percentage applied when paid after the due date. ex: 1.0
+  # - amount [integer]: invoice amount in cents. ex: 1234 (= R$ 12.34)
+  # - nominal_amount [integer]: nominal amount of the invoice in cents. ex: 1234 (= R$ 12.34)
+  # - status [string]: current IssuingBillingInvoice status. ex: 'created', 'paid', 'overdue'
+  # - brcode [string]: BR Code for the invoice payment. ex: '00020101021226930014br.gov.bcb.pix2571brcode-h.development.starkinfra.com'
+  # - link [string]: public invoice webpage URL. ex: 'https://starkbank-card-issuer.sandbox.starkbank.com/billinginvoicelink/97de4d51e8984c459639a645ce920abb'
+  # - due [DateTime]: invoice due and expiration datetime in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - period_start [DateTime]: billing cycle start datetime. Maps to wire field 'start'. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - period_end [DateTime]: billing cycle end datetime. Maps to wire field 'end'. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingBillingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the IssuingBillingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingBillingInvoice < StarkCore::Utils::Resource
+    attr_reader :id, :tax_id, :name, :fine, :interest, :amount, :nominal_amount, :status, :brcode, :link,
+                :due, :period_start, :period_end, :created, :updated
+    def initialize(
+      id: nil, tax_id: nil, name: nil, fine: nil, interest: nil, amount: nil, nominal_amount: nil, status: nil,
+      brcode: nil, link: nil, due: nil, period_start: nil, period_end: nil, created: nil, updated: nil
+    )
+      super(id)
+      @tax_id = tax_id
+      @name = name
+      @fine = fine
+      @interest = interest
+      @amount = amount
+      @nominal_amount = nominal_amount
+      @status = status
+      @brcode = brcode
+      @link = link
+      @due = StarkCore::Utils::Checks.check_datetime(due)
+      @period_start = StarkCore::Utils::Checks.check_datetime(period_start)
+      @period_end = StarkCore::Utils::Checks.check_datetime(period_end)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Retrieve a specific IssuingBillingInvoice
+    #
+    # Receive a single IssuingBillingInvoice object previously created in the Stark Infra API by its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingBillingInvoice object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve IssuingBillingInvoices
+    #
+    # Receive a generator of IssuingBillingInvoice objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'paid', 'overdue']
+    # - id [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingBillingInvoice objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, id: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        id: id,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingBillingInvoices
+    #
+    # Receive a list of up to 100 IssuingBillingInvoice objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'paid', 'overdue']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingBillingInvoice objects with updated attributes
+    # - cursor to retrieve the next page of IssuingBillingInvoice objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingBillingInvoice',
+        resource_maker: proc { |json|
+          IssuingBillingInvoice.new(
+            id: json['id'],
+            tax_id: json['tax_id'],
+            name: json['name'],
+            fine: json['fine'],
+            interest: json['interest'],
+            amount: json['amount'],
+            nominal_amount: json['nominal_amount'],
+            status: json['status'],
+            brcode: json['brcode'],
+            link: json['link'],
+            due: json['due'],
+            period_start: json['start'],
+            period_end: json['end'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuing_billing_transaction/issuing_billing_transaction.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # IssuingBillingTransaction object
+  #
+  # The IssuingBillingTransaction objects created in your Workspace report the
+  # transactions that compose the billing invoices of your Issuing operation.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingBillingTransaction is created. ex: '5656565656565656'
+  # - amount [integer]: transaction amount in cents. ex: 1234 (= R$ 12.34)
+  # - invoice_id [string]: id of the parent billing invoice the transaction belongs to. May be nil when the transaction is not tied to an invoice. ex: '5656565656565656'
+  # - installment [integer]: installment number of the transaction. ex: 1
+  # - installment_count [integer]: total number of installments of the transaction. ex: 12
+  # - balance [integer]: remaining issuing balance in cents after the transaction. ex: 1234 (= R$ 12.34)
+  # - holder_name [string]: card holder name. ex: 'Tony Stark'
+  # - source [string]: transaction source. ex: 'issuing-purchase'
+  # - external_id [string]: external transaction id. ex: 'my-external-id-123456'
+  # - description [string]: transaction description. ex: 'Purchase at Stark Store'
+  # - card_ending [string]: last 4 digits of the card number. ex: '1234'
+  # - tax [integer]: IOF amount in cents applied to the transaction
+  # - rate [float]: Conversion rate applied to international transactions
+  # - merchant_amount [integer]: merchant amount in cents. ex: 1234 (= R$ 12.34)
+  # - merchant_currency_code [string]: merchant currency code in ISO 4217 format. ex: 'USD'
+  # - created [DateTime]: creation datetime for the IssuingBillingTransaction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingBillingTransaction < StarkCore::Utils::Resource
+    attr_reader :id, :amount, :invoice_id, :installment, :installment_count, :balance, :holder_name, :source,
+                :external_id, :description, :card_ending, :tax, :rate, :merchant_amount, :merchant_currency_code,
+                :created
+    def initialize(
+      id: nil, amount: nil, invoice_id: nil, installment: nil, installment_count: nil, balance: nil,
+      holder_name: nil, source: nil, external_id: nil, description: nil, card_ending: nil, tax: nil, rate: nil,
+      merchant_amount: nil, merchant_currency_code: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @invoice_id = invoice_id
+      @installment = installment
+      @installment_count = installment_count
+      @balance = balance
+      @holder_name = holder_name
+      @source = source
+      @external_id = external_id
+      @description = description
+      @card_ending = card_ending
+      @tax = tax
+      @rate = rate
+      @merchant_amount = merchant_amount
+      @merchant_currency_code = merchant_currency_code
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+    end
+
+    # # Retrieve IssuingBillingTransactions
+    #
+    # Receive a generator of IssuingBillingTransaction objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - invoice_id [string, default nil]: filter for transactions of a specific billing invoice. ex: '5656565656565656'
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingBillingTransaction objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, invoice_id: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        invoice_id: invoice_id,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingBillingTransactions
+    #
+    # Receive a list of up to 100 IssuingBillingTransaction objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - invoice_id [string, default nil]: filter for transactions of a specific billing invoice. ex: '5656565656565656'
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingBillingTransaction objects with updated attributes
+    # - cursor to retrieve the next page of IssuingBillingTransaction objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, invoice_id: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        invoice_id: invoice_id,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingBillingTransaction',
+        resource_maker: proc { |json|
+          IssuingBillingTransaction.new(
+            id: json['id'],
+            amount: json['amount'],
+            invoice_id: json['invoice_id'],
+            installment: json['installment'],
+            installment_count: json['installment_count'],
+            balance: json['balance'],
+            holder_name: json['holder_name'],
+            source: json['source'],
+            external_id: json['external_id'],
+            description: json['description'],
+            card_ending: json['card_ending'],
+            tax: json['tax'],
+            rate: json['rate'],
+            merchant_amount: json['merchant_amount'],
+            merchant_currency_code: json['merchant_currency_code'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuing_card/issuing_card.rb

@@ -25,12 +25,13 @@ module StarkInfra
   # - city [string, default sub-issuer city]: card holder address city. ex: 'Rio de Janeiro'
   # - state_code [string, default sub-issuer state code]: card holder address state. ex: 'GO'
   # - zip_code [string, default sub-issuer zip code]: card holder address zip code. ex: '01311-200'
+  # - type [string, default 'virtual']: card type, settable on creation. Options: 'virtual', 'physical'. ex: 'virtual'
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingCard is created. ex: '5656565656565656'
   # - holder_id [string]: card holder unique id. ex: '5656565656565656'
-  # - type [string]: card type. ex: 'virtual'
   # - status [string]: current IssuingCard status. ex: 'active', 'blocked', 'canceled', 'expired'.
+  # - is_pin_defined [boolean]: Whether the card has a PIN defined. Returned only when "expand=isPinDefined" is informed in the request
   # - number [string]: [EXPANDABLE] masked card number. Expand to unmask the value. ex: '123'.
   # - security_code [string]: [EXPANDABLE] masked card verification value (cvv). Expand to unmask the value. ex: '123'.
   # - expiration [DateTime]: [EXPANDABLE] masked card expiration datetime. Expand to unmask the value. ex: DateTime.new(2032, 3, 10, 10, 30, 0, 0)
@@ -39,11 +40,11 @@ module StarkInfra
   class IssuingCard < StarkCore::Utils::Resource
     attr_reader :id, :holder_name, :holder_tax_id, :holder_external_id, :display_name, :rules, :product_id, :tags,
                 :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :holder_id,
-                :type, :status, :number, :security_code, :expiration, :created, :updated
+                :type, :status, :is_pin_defined, :number, :security_code, :expiration, :created, :updated
     def initialize(
       holder_name: , holder_tax_id: , holder_external_id: , display_name: nil, rules: nil, product_id: nil, tags: nil,
       street_line_1: nil, street_line_2: nil, district: nil, city: nil, state_code: nil, zip_code: nil, id: nil,
-      holder_id: nil, type: nil, status: nil, number: nil, security_code: nil, expiration: nil, created: nil, updated: nil
+      holder_id: nil, type: nil, status: nil, is_pin_defined: nil, number: nil, security_code: nil, expiration: nil, created: nil, updated: nil
     )
       super(id)
       @holder_name = holder_name
@@ -62,6 +63,7 @@ module StarkInfra
       @holder_id = holder_id
       @type = type
       @status = status
+      @is_pin_defined = is_pin_defined
       @number = number
       @security_code = security_code
       expiration = nil if !expiration.nil? && expiration.include?('*')
@@ -72,7 +74,8 @@ module StarkInfra
 
     # # Create IssuingCards
     #
-    # Send a list of IssuingCard objects for creation in the Stark Infra API
+    # Send a list of IssuingCard objects for creation in the Stark Infra API. Use this method to create up
+    # to 100 new IssuingCards at a time.
     #
     # ## Parameters (required):
     # - cards [list of IssuingCard objects]: list of IssuingCard objects to be created in the API
@@ -190,7 +193,7 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - status [string, default nil]: You may block the IssuingCard by passing 'blocked' or activate by passing 'active' in the status
-    # - pin [string, default nil]: You may unlock your physical card by passing its PIN. This is also the PIN you use to authorize a purhcase.
+    # - pin [string, default nil]: numeric string of 4 to 6 digits, used to unlock a physical card and authorize purchases. Write-only — never returned; check expand: ['isPinDefined'] to see whether a PIN is set. A pending physical card must also receive this PIN to be activated: passing it alone activates the card, and setting status to 'active' on a pending physical card without a PIN is rejected.
     # - display_name [string, default nil]: card displayed name
     # - rules [list of IssuingRule objects, default nil]: [EXPANDABLE] list of card spending rules.
     # - tags [list of strings, default nil]: list of strings for tagging
@@ -213,7 +216,7 @@ module StarkInfra
 
     # # Cancel an IssuingCard entity
     #
-    # Cancel an IssuingCard entity previously created in the Stark Infra API
+    # Cancel an IssuingCard entity previously created in the Stark Infra API. This action is irreversible.
     #
     # ## Parameters (required):
     # - id [string]: IssuingCard unique id. ex: '5656565656565656'
@@ -249,6 +252,7 @@ module StarkInfra
             holder_id: json['holder_id'],
             type: json['type'],
             status: json['status'],
+            is_pin_defined: json['is_pin_defined'],
             number: json['number'],
             security_code: json['security_code'],
             expiration: json['expiration'],

data/lib/issuing_design/issuing_design.rb

@@ -104,6 +104,15 @@ module StarkInfra
       StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
     end
 
+    # # Parse IssuingDesigns
+    #
+    # Converts a list of hashes into a list of IssuingDesign objects.
+    #
+    # ## Parameters (required):
+    # - designs [list of hashes]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed IssuingDesign objects
     def self.parse_designs(designs)
       resource_maker = StarkInfra::IssuingDesign.resource[:resource_maker]
       return designs if designs.nil?

data/lib/issuing_embossing_request/issuing_embossing_request.rb

@@ -18,7 +18,7 @@ module StarkInfra
   # - shipping_state_code [string]: shipping state code. ex: "NY"
   # - shipping_street_line_1 [string]: shipping main address. ex: "AVENUE OF THE AMERICAS"
   # - shipping_street_line_2 [string]: shipping address complement. ex: "Apt. 6"
-  # - shipping_service [string]: shipping service. ex: "loggi"
+  # - shipping_service [string]: shipping service. Options: 'loggi', 'conveyor'.
   # - shipping_tracking_number [string]: shipping tracking number. ex: "5656565656565656"
   # - shipping_zip_code [string]: shipping zip code. ex: "12345-678"
   #
@@ -73,7 +73,8 @@ module StarkInfra
 
     # # Create IssuingEmbossingRequests
     #
-    # Send a list of IssuingEmbossingRequest objects for creation in the Stark Infra API
+    # Send a list of IssuingEmbossingRequest objects for creation in the Stark Infra API. Use this method to
+    # create up to 100 new IssuingEmbossingRequests at a time.
     #
     # ## Parameters (required):
     # - requests [list of IssuingEmbossingRequest objects]: list of IssuingEmbossingRequest objects to be created in the API

data/lib/issuing_holder/issuing_holder.rb

@@ -44,7 +44,8 @@ module StarkInfra
 
     # # Create IssuingHolders
     #
-    # Send a list of IssuingHolder objects for creation in the Stark Infra API
+    # Send a list of IssuingHolder objects for creation in the Stark Infra API. Use this method to create up
+    # to 100 new IssuingHolders at a time.
     #
     # ## Parameters (required):
     # - holders [list of IssuingHolder objects]: list of IssuingHolder objects to be created in the API
@@ -147,13 +148,13 @@ module StarkInfra
 
     # # Update IssuingHolder entity
     #
-    # Update an IssuingHolder by passing id, if it hasn't been paid yet.
+    # Update an IssuingHolder by passing id. A canceled holder can no longer be updated.
     #
     # ## Parameters (required):
     # - id [string]: IssuingHolder id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - status [string, default nil]: You may block the IssuingHolder by passing 'blocked' in the status
+    # - status [string, default nil]: status to update the holder to. Options: 'active', 'blocked'.
     # - name [string, default nil]: card holder name.
     # - tags [list of strings, default nil]: list of strings for tagging
     # - rules [list of IssuingRule objects, default nil]: list of objects that represent the holder's spending rules.
@@ -175,7 +176,7 @@ module StarkInfra
 
     # # Cancel an IssuingHolder entity
     #
-    # Cancel an IssuingHolder entity previously created in the Stark Infra API
+    # Cancel an IssuingHolder entity previously created in the Stark Infra API. This action is irreversible.
     #
     # ## Parameters (required):
     # - id [string]: IssuingHolder unique id. ex: '5656565656565656'
@@ -186,7 +187,7 @@ module StarkInfra
     # ## Return:
     # - canceled IssuingHolder object
     def self.cancel(id, user: nil)
-      StarkCore::Utils::Rest.delete_id(id: id, user: user, **resource)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 
     def self.resource