Class: Increase::Resources::LockboxAddresses

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/lockbox_addresses.rb,
sig/increase/resources/lockbox_addresses.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LockboxAddresses

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LockboxAddresses.

Parameters:



117
118
119
 
# File 'lib/increase/resources/lockbox_addresses.rb', line 117

def initialize(client:)
  @client = client
end

Instance Method Details

#create(description: nil, request_options: {}) ⇒ Increase::Models::LockboxAddress

The Lockbox Address starts with a pending status and a null address. Shortly after creation, Increase generates the mailing address and the status becomes active. You can only create Lockbox Recipients for an active Lockbox Address.

Parameters:

  • description (String) —

    The description you choose for the Lockbox Address.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/increase/resources/lockbox_addresses.rb', line 20

def create(params = {})
  parsed, options = Increase::LockboxAddressCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "lockbox_addresses",
    body: parsed,
    model: Increase::LockboxAddress,
    options: options
  )
end

#list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::LockboxAddress>

List Lockbox Addresses

Parameters:

  • created_at (Increase::Models::LockboxAddressListParams::CreatedAt)
  • cursor (String) —

    Return the page of entries after this one.

  • idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/increase/resources/lockbox_addresses.rb', line 101

def list(params = {})
  parsed, options = Increase::LockboxAddressListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "lockbox_addresses",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::LockboxAddress,
    options: options
  )
end

#retrieve(lockbox_address_id, request_options: {}) ⇒ Increase::Models::LockboxAddress

Retrieve a Lockbox Address

Parameters:

  • lockbox_address_id (String) —

    The identifier of the Lockbox Address to retrieve.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/increase/resources/lockbox_addresses.rb', line 42

def retrieve(lockbox_address_id, params = {})
  @client.request(
    method: :get,
    path: ["lockbox_addresses/%1$s", lockbox_address_id],
    model: Increase::LockboxAddress,
    options: params[:request_options]
  )
end

#update(lockbox_address_id, description: nil, status: nil, request_options: {}) ⇒ Increase::Models::LockboxAddress

Update a Lockbox Address

Parameters:

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/increase/resources/lockbox_addresses.rb', line 67

def update(lockbox_address_id, params = {})
  parsed, options = Increase::LockboxAddressUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["lockbox_addresses/%1$s", lockbox_address_id],
    body: parsed,
    model: Increase::LockboxAddress,
    options: options
  )
end